Docstring updates for Axes.fill and Axes.pie
#10150
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
dec3b9a to
9c2a3f6
Compare
|
Ok, I've rewrapped the paragraphs. |
tacaswell
reviewed
Jan 3, 2018
| Each polygon is defined by the lists of *x* and *y* positions of | ||
| its nodes, optionally followed by by a *color* specifier. See | ||
| :mod:`matplotlib.colors` for supported color specifiers. The | ||
| standard color cycle is used for polygons without a color |
There was a problem hiding this comment.
iirc this is the same cycle, but a different cycler instance than the one used by plot. Not sure if that is a detail worth including here.
There was a problem hiding this comment.
Is this important and intentional? Do we want to guarantee this as part of the API?
If not, I would consider it an implementation detail and not document it.
anntzer
reviewed
Jan 3, 2018
lib/matplotlib/axes/_axes.py
Outdated
|
|
||
| Parameters | ||
| ---------- | ||
| x : array-like | ||
| The input array used to make the pie chart. | ||
| The data defining the wedge sizes. |
There was a problem hiding this comment.
"The wedge sizes." seems enough :)
anntzer
reviewed
Jan 3, 2018
| @@ -2581,8 +2582,8 @@ def pie(self, x, explode=None, labels=None, colors=None, | |||
| Dict of arguments to pass to the text objects. | |||
There was a problem hiding this comment.
just above (in wedgeprops): missing space before double backquote
9c2a3f6 to
4ac0dd1
Compare
dstansby
approved these changes
Jan 4, 2018
jklymak
added a commit
that referenced
this pull request
Jan 5, 2018
Backport PR #10150 on branch v2.1.x
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 part of #10148: Docstring updates for
Axes.fillandAxes.pie.