Improve docs for Cython extensions #1169
Merged
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
This means we don't need to duplicate the signature in the reST files and just leave it to autodoc.
These means we can just use backticks and don't need to add a specific :func:, :class:, etc.
Also fix errors.
Also fix errors: return values were treated as multiple types; __cinit__ is not read as a constructor; types were missing.
|
In the outline, |
dopplershift
approved these changes
Nov 6, 2018
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.
Rationale
Both
.geodesicand.traceare documented, but do not show up in the docs. There are currently errors and/or bad looking bits that are not fixed because they never show up. We can also use Cython'sembedsignatureoption to avoid copying out signatures in docs.Implications
Fixes #996.