DOC: API reference tweaks & clean-up #89
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add them manually instead, without type hints. It is a bit more tedious to maintain but the result is more consistent and readable. - Pybind11 type hints not always reliable (e.g., non-vectorized arguments of py::vectorize functions show as numpy.ndarray, too generic return type) - didn't work with sphinx's ``autodoc_typehints = "none"``, which seemed to be ignored for some reason. Adding type hints in the function signatures in the API documentation makes those signature less readable and doesn't add much information (type hints already in the parameter and return description sections) Also add "Returns" sections in docstrings more globally.
Return values that are consistent with shapely for collections.
Also move Projection to api-hidden.
Also move get_x and get_y functions to geography.cpp (geography properties).
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #89 +/- ##
==========================================
- Coverage 94.00% 86.36% -7.64%
==========================================
Files 5 13 +8
Lines 200 814 +614
Branches 8 63 +55
==========================================
+ Hits 188 703 +515
- Misses 5 81 +76
- Partials 7 30 +23 ☔ View full report in Codecov by Sentry. |
|
@jorisvandenbossche I addressed your review comments in the last two commits. Do you want to review it before merging this? Ortherwise this is ready I think. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mostly cosmetic changes to make the API reference documentation nicer and more consistent across the library.
More details in each commit message.
Also includes changes suggested in #87.