Fix various numpydoc style issues #16858
Merged
Conversation
This file contains hidden or 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
The numpydoc sections listing is prescriptive, not descriptive, and the order should be followed.
As noted before, the ordering for numpydoc is required, so Examples should be last.
anntzer
reviewed
Mar 20, 2020
anntzer
reviewed
Mar 20, 2020
anntzer
reviewed
Mar 20, 2020
anntzer
approved these changes
Mar 20, 2020
The numpydoc standard says there should not be a name if there's only one return value. Additionally, split up some return types that are tuples, because they really should get separate entries for each value.
The standard is to keep quotes on their own line if the docstring covers multiple lines.
|
I actually found quite a few more, see the diff. |
dstansby
approved these changes
Mar 21, 2020
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.
PR Summary
I'm trying out
numpydoc --validateand I'm not sure it's quite ready to use in CI yet, but there are some issues we can fix right now.The ordering of sections in the numpydoc example is prescriptive, so we this changes some incorrectly ordered docstrings. Return values don't need a name when there's only one returned item. The rest is just small typos, for details see the commit messages.
PR Checklist