Repository navigation
Update writing docs concerning explicit parameter lists - #10280
Merged
Merged
Conversation
anntzer
approved these changes
Jan 21, 2018
Member
|
Thanks @timhoffm ! |
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
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
As discussed in #10276, the explicit parameter lists should also be migrated from
[ | ]to the numpydoc standard{ , }.There are a lot of occurences still in the docs. At some point, one should grep through the existing docstrings. For reference, here is a regexp to search for two-element occurences:
\[\s*(\S+)\s*\|\s*(\S+)\s*\]