Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docstring updates for `Axes.fill` and `Axes.pie` #10150

Merged
merged 2 commits into from Jan 5, 2018

Conversation

Projects
None yet
5 participants
@timhoffm
Copy link
Member

commented Jan 3, 2018

PR Summary

As part of #10148: Docstring updates for Axes.fill and Axes.pie.

@timhoffm timhoffm force-pushed the timhoffm:axes-plotting-docstrings branch from dec3b9a to 9c2a3f6 Jan 3, 2018

@timhoffm

This comment has been minimized.

Copy link
Member Author

commented Jan 3, 2018

Ok, I've rewrapped the paragraphs.

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

This comment has been minimized.

Copy link
@tacaswell

tacaswell Jan 3, 2018

Member

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.

This comment has been minimized.

Copy link
@timhoffm

timhoffm Jan 3, 2018

Author Member

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.

Parameters
----------
x : array-like
The input array used to make the pie chart.
The data defining the wedge sizes.

This comment has been minimized.

Copy link
@anntzer

anntzer Jan 3, 2018

Contributor

"The wedge sizes." seems enough :)

@@ -2581,8 +2582,8 @@ def pie(self, x, explode=None, labels=None, colors=None,
Dict of arguments to pass to the text objects.

This comment has been minimized.

Copy link
@anntzer

anntzer Jan 3, 2018

Contributor

just above (in wedgeprops): missing space before double backquote

@timhoffm timhoffm force-pushed the timhoffm:axes-plotting-docstrings branch from 9c2a3f6 to 4ac0dd1 Jan 4, 2018

@dstansby dstansby added this to the v2.1.2 milestone Jan 4, 2018

@jklymak jklymak merged commit f4d845b into matplotlib:master Jan 5, 2018

5 checks passed

ci/circleci: docs-python27 Your tests passed on CircleCI!
Details
ci/circleci: docs-python35 Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
lgtm analysis: Python No alert changes
Details

meeseeksdev bot pushed a commit that referenced this pull request Jan 5, 2018

jklymak added a commit that referenced this pull request Jan 5, 2018

@timhoffm timhoffm deleted the timhoffm:axes-plotting-docstrings branch Jan 6, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.