DOC: Fix docstrings for multiple parameters #5186
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
:param x, y: is wrong, it looks like *y* (x,) in the result :param x,y: is better, it looks like *x,y* Really I suspect sphinx doesn't support describing multiple parameters in one list item, but this way it looks less nonsensical. Idea from https://sources.debian.net/src/matplotlib/1.4.2-3.1/debian/patches/50_bts608942_spaces_in_param_args.patch/ but this fixes more cases.
|
These really should be converted to numpydoc format which does support multiple parameters per line. |
|
Yeah -- we should eventually be aiming for numpydoc/napolean across the board, I think... |
tacaswell
added a commit
that referenced
this pull request
Oct 11, 2015
DOC: Fix docstrings for multiple parameters
tacaswell
added a commit
that referenced
this pull request
Oct 11, 2015
DOC: Fix docstrings for multiple parameters
|
back-ported as 207be0f |
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.
:param x, y:is wrong, it looks like y (x,) in the result:param x,y:is better, it looks like x,yReally I suspect sphinx doesn't support describing multiple parameters in one list item, but this way it looks less nonsensical.
Idea from https://sources.debian.net/src/matplotlib/1.4.2-3.1/debian/patches/50_bts608942_spaces_in_param_args.patch/ but this fixes more cases.