Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize libpysal/examples/*.py docstrings #294

Merged
merged 19 commits into from
Jun 28, 2020

Conversation

jGaboardi
Copy link
Member

@jGaboardi jGaboardi commented Jun 5, 2020

See #290

This PR adds type hints and standardizes the following docstrings:

  • libpysal/examples/__init__.py
  • libpysal/examples/base.py
  • libpysal/examples/builtin.py
  • libpysal/examples/remotes.py

@jGaboardi jGaboardi self-assigned this Jun 5, 2020
@jGaboardi jGaboardi added docs WIP Work in progress, do not merge. Discussion only. labels Jun 5, 2020
@codecov
Copy link

codecov bot commented Jun 5, 2020

Codecov Report

Merging #294 into master will increase coverage by 0.00%.
The diff coverage is 64.77%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #294   +/-   ##
=======================================
  Coverage   81.12%   81.13%           
=======================================
  Files         115      115           
  Lines       11674    11679    +5     
=======================================
+ Hits         9471     9476    +5     
  Misses       2203     2203           
Impacted Files Coverage Δ
libpysal/examples/remotes.py 83.56% <ø> (ø)
libpysal/examples/base.py 53.02% <45.94%> (+0.31%) ⬆️
libpysal/common.py 82.69% <55.55%> (+0.33%) ⬆️
libpysal/cg/ops/_accessors.py 80.00% <75.00%> (ø)
libpysal/cg/voronoi.py 79.00% <80.00%> (+0.42%) ⬆️
libpysal/examples/builtin.py 89.74% <85.71%> (ø)
libpysal/examples/__init__.py 90.90% <100.00%> (+0.43%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eeb90f5...2851b5c. Read the comment docs.

@jGaboardi
Copy link
Member Author

Revisit after @slumnitz's catch.

@jGaboardi jGaboardi requested a review from sjsrey June 26, 2020 14:04
@jGaboardi jGaboardi removed the WIP Work in progress, do not merge. Discussion only. label Jun 26, 2020
@jGaboardi jGaboardi changed the title [WIP] Standardize libpysal/examples/*.py docstrings Standardize libpysal/examples/*.py docstrings Jun 26, 2020
@jGaboardi jGaboardi added this to In progress in Standardize Docstrings Jun 26, 2020
@jGaboardi
Copy link
Member Author

Currently failing with:

requests.exceptions.MissingSchema: Invalid URL 'data/ncovr.zip': No schema supplied. Perhaps you meant http://data/ncovr.zip?

@sjsrey
Copy link
Member

sjsrey commented Jun 28, 2020

Currently failing with:

requests.exceptions.MissingSchema: Invalid URL 'data/ncovr.zip': No schema supplied. Perhaps you meant http://data/ncovr.zip?

Chicago relocated the example data to GitHub so our crawler has to be updated. See #295

@sjsrey sjsrey merged commit 4619be9 into pysal:master Jun 28, 2020
@jGaboardi jGaboardi moved this from In progress to Done in Standardize Docstrings Jul 14, 2020
@jGaboardi jGaboardi deleted the eaxamples_standarize_docs branch January 24, 2021 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants