Use numpydoc-style parameter lists for choices #11548
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
anntzer
reviewed
Jul 2, 2018
| @@ -234,8 +234,9 @@ def get_linewidth(self): | |||
|
|
|||
| def get_linestyle(self): | |||
| """ | |||
| Return the linestyle. Will be one of ['solid' | 'dashed' | | |||
| 'dashdot' | 'dotted'] | |||
| Return the linestyle. | |||
There was a problem hiding this comment.
Perhaps make the whole thing a single Returns section?
There was a problem hiding this comment.
Actually the content is incomplete. There can be much more return values. See set_linestyle(). For simplicity I don't list them here again but just remove the comment on the returned content.
8207894 to
3745a56
Compare
anntzer
reviewed
Jul 2, 2018
lib/matplotlib/collections.py
Outdated
| Other Parameters | ||
| ---------------- | ||
| **kwargs | ||
| Additional kwargs inherited from the base :class:`Collection`: |
There was a problem hiding this comment.
additional : at end of line.
3745a56 to
10c04ca
Compare
anntzer
approved these changes
Jul 3, 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.
PR Summary
Note: Not all of the corrected places are converted to full numpydoc Parameter sections yet. However, it's also easier to do so later, if we have already the possible parameter values formatted correctly.