Numpydoc-ify various functions #17752
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
Jun 25, 2020
anntzer
reviewed
Jun 25, 2020
lib/matplotlib/dates.py
Outdated
| `~datetime.datetime.strftime` format string. | ||
| Parameters | ||
| ---------- | ||
| t: |
anntzer
reviewed
Jun 25, 2020
anntzer
reviewed
Jun 25, 2020
anntzer
reviewed
Jun 25, 2020
anntzer
reviewed
Jun 25, 2020
anntzer
reviewed
Jun 25, 2020
anntzer
reviewed
Jun 25, 2020
anntzer
reviewed
Jun 25, 2020
lib/matplotlib/sankey.py
Outdated
| =============== ========================================== | ||
| Other Parameters | ||
| ---------------- | ||
| quadrant : int, {0, 1, 2, 3} |
There was a problem hiding this comment.
I guess the only acceptable values are 0, 1, 2, 3, not any int.
(Also perhaps state the defaults.)
There was a problem hiding this comment.
I'm not really sure what 0, 1, 2, 3 mean, and I'm getting the feeling the optimization is not really worth it and we should just replace this function with Path.arc... But that would be a separate PR.
timhoffm
reviewed
Jun 26, 2020
lib/matplotlib/legend.py
Outdated
| @@ -1079,8 +1090,9 @@ def set_draggable(self, state, use_blit=False, update='loc'): | |||
|
|
|||
| Returns | |||
| ------- | |||
| If *state* is ``True`` this returns the `~.DraggableLegend` helper | |||
| instance. Otherwise this returns ``None``. | |||
| `~.DraggableLegend` or *None* | |||
There was a problem hiding this comment.
Suggested change
| `~.DraggableLegend` or *None* | |
| `.DraggableLegend` or *None* |
~ shortens the given name to the last part. Since we only have one part here anyway, ~does not have any effect and it's more readable to leave it out.
lib/matplotlib/legend.py
Outdated
| If *state* is ``True`` this returns the `~.DraggableLegend` helper | ||
| instance. Otherwise this returns ``None``. | ||
| `~.DraggableLegend` or *None* | ||
| If *state* is ``True`` this returns the `~.DraggableLegend` helper |
There was a problem hiding this comment.
Suggested change
| If *state* is ``True`` this returns the `~.DraggableLegend` helper | |
| If *state* is ``True`` this returns the `.DraggableLegend` helper |
|
Anyone can merge on green. |
timhoffm
approved these changes
Jun 26, 2020
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jun 26, 2020
dstansby
added a commit
that referenced
this pull request
Jun 26, 2020
…752-on-v3.3.x Backport PR #17752 on branch v3.3.x (Numpydoc-ify various functions)
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
Sorry, this is a bit all-over-the-place. I started this a long time ago, and in the interest of it not becoming further out of date, I decided to clean it up a bit and post it. Unfortunately, it's a bit of a hodge-podge of different things right now.
PR Checklist