DOC: Clean up the pie docstring PR #8371

phobson · 2017-03-24T16:25:34Z

Supersedes #8357

Builds upon @kahnchana 's work with some minor reorganization

NelleV · 2017-03-24T16:29:59Z

lib/matplotlib/axes/_axes.py


-            - *patches* is a sequence of
-              :class:`matplotlib.patches.Wedge` instances
+        .. plot:: mpl_examples/pie_and_polar_charts/pie_demo_features.py


Soon, we won't need this anymore :D

@NelleV curious: what does the future look like in this regard?

On matplotlib, I am not sure, as our pyplot API page is gigantic, but on sklearn it looks like this:
http://scikit-learn.org/stable/modules/generated/sklearn.isotonic.IsotonicRegression.html#sklearn.isotonic.IsotonicRegression

If you scroll down, you'll see all examples using the isotonic regression (there's only one).
I am not sure how to activate this feature just yet, but that is my next step :)

oooooooh fancy!

NelleV

There's a merge/rebase problem in here.

NelleV · 2017-03-24T16:30:17Z

lib/matplotlib/tests/test_backend_pgf.py

 @needs_xelatex
 @pytest.mark.style('default')
 @pytest.mark.backend('pgf')
+=======


There's a problem in this file.

phobson · 2017-03-24T16:36:15Z

@NelleV I forgot that the test_backend_pgf file had been modified in the original PR. I took that out along with the other extraneous whitespace changes

NelleV · 2017-03-24T16:38:15Z

Feel free to self-merge once the tests pass. This has been approved already in the previous PR.

phobson · 2017-03-24T17:27:12Z

@NelleV Does this error from the doc build mean anything to you?

/home/travis/build/matplotlib/matplotlib/lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.pie:97: ERROR: Error in "rubric" directive:
no content permitted.

.. rubric:: Examples

        .. plot:: mpl_examples/pie_and_polar_charts/pie_demo_features.py

Building HTML failed.

NelleV · 2017-03-24T17:50:56Z

It's an indentation problem. That's all I can say :(

phobson · 2017-03-24T17:52:14Z

Ok, I'll dig into that later

QuLogic · 2017-03-24T20:02:05Z

The previous PR was never approved, so please don't self-merge.

phobson · 2017-03-24T20:13:30Z

@QuLogic don't worry. wasn't going to after seen that weird "rubric" failure.

QuLogic · 2017-03-24T20:03:32Z

lib/matplotlib/axes/_axes.py

@@ -2682,9 +2684,9 @@ def get_next_color():
            self.set_frame_on(False)

            self.set_xlim((-1.25 + center[0],
-                            1.25 + center[0]))
+                          1.25 + center[0]))


This is not indented correctly.

QuLogic · 2017-03-24T20:06:01Z

lib/matplotlib/axes/_axes.py


-          *explode*: [ *None* | len(x) sequence ]
+        explode : array-like, optional (default is None)


I think our convention has been optional, default: None.

QuLogic · 2017-03-24T20:10:24Z

lib/matplotlib/axes/_axes.py

            If not *None*, is a string or function used to label the wedges
            with their numeric value.  The label will be placed inside the
            wedge.  If it is a format string, the label will be ``fmt%pct``.
            If it is a function, it will be called.

-          *pctdistance*: scalar
+        pctdistance : float, optional (default is 0.6)
            The ratio between the center of each pie slice and the
            start of the text generated by *autopct*.  Ignored if
            *autopct* is *None*; default is 0.6.


Can delete default here.

QuLogic · 2017-03-24T20:11:45Z

lib/matplotlib/axes/_axes.py

+        autotexts : list
+            A is a list of :class:`~matplotlib.text.Text` instances for the
+            numeric labels. Is returned only if parameter *autopct* is
+            not *None*. 


Trailing whitespace.

QuLogic · 2017-03-24T20:14:29Z

lib/matplotlib/axes/_axes.py

    def pie(self, x, explode=None, labels=None, colors=None,
            autopct=None, pctdistance=0.6, shadow=False, labeldistance=1.1,
            startangle=None, radius=None, counterclock=True,
            wedgeprops=None, textprops=None, center=(0, 0),
            frame=False, rotatelabels=False):
-        r"""
-        Plot a pie chart.
+        r"""Plot a pie chart.


Can you try reverting this? I think it might fix it. At least it seems to be working locally...

Question: does it even need to be a raw string?

I don't think so, but if everything breaks when you remove the raw string, then it needs to be a raw string :p

I don't see any backslashes, so maybe not?

NelleV · 2017-03-24T20:18:55Z

The indentation problem probably comes from our magic interpolation docstring functions.

QuLogic · 2017-03-25T04:19:00Z

Congrats on attaining AppVeyor build 1000.

DOC: Clean up the pie docstring PR

dstansby · 2017-03-25T16:47:10Z

Backported to 2.0.x via 5e3df66

phobson · 2017-03-26T15:53:38Z

@kahnchana thanks for this!

phobson mentioned this pull request Mar 24, 2017

Convert docstring of Axes.pie() into numpydoc #8357

Closed

NelleV reviewed Mar 24, 2017

View reviewed changes

NelleV requested changes Mar 24, 2017

View reviewed changes

kahnchana and others added 2 commits March 24, 2017 09:34

DOC: convert axes.pie doctring to numpy doc

1de59f4

DOC: sync order of axes.pie args to call sig

6e74e7d

phobson force-pushed the pie-docstring branch from 08d2a5e to 6e74e7d Compare March 24, 2017 16:34

NelleV approved these changes Mar 24, 2017

View reviewed changes

DOC: move pie's Axes aspect advice into notes section

2128459

QuLogic reviewed Mar 24, 2017

View reviewed changes

DOC: use colons for Axes.pie defaults, etc.

abff9ff

QuLogic added this to the 2.0.1 (next bug fix release) milestone Mar 25, 2017

QuLogic merged commit 199cea7 into matplotlib:master Mar 25, 2017

QuLogic added the Needs backport label Mar 25, 2017

dstansby pushed a commit that referenced this pull request Mar 25, 2017

Merge pull request #8371 from phobson/pie-docstring

5e3df66

DOC: Clean up the pie docstring PR

dstansby removed the Needs backport label Mar 25, 2017

QuLogic added the Documentation label Mar 25, 2017

phobson deleted the pie-docstring branch March 26, 2017 15:53

txxia mentioned this pull request Apr 1, 2017

Convert docstring of Axes.pie() into numpydoc #8272

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Clean up the pie docstring PR #8371

DOC: Clean up the pie docstring PR #8371

phobson commented Mar 24, 2017

NelleV Mar 24, 2017

phobson Mar 24, 2017

NelleV Mar 24, 2017

phobson Mar 24, 2017

NelleV left a comment

NelleV Mar 24, 2017

phobson commented Mar 24, 2017

NelleV commented Mar 24, 2017 •

edited

Loading

phobson commented Mar 24, 2017

NelleV commented Mar 24, 2017

phobson commented Mar 24, 2017

QuLogic commented Mar 24, 2017 •

edited

Loading

phobson commented Mar 24, 2017

QuLogic Mar 24, 2017

QuLogic Mar 24, 2017

QuLogic Mar 24, 2017

QuLogic Mar 24, 2017

QuLogic Mar 24, 2017

phobson Mar 24, 2017

NelleV Mar 24, 2017

QuLogic Mar 24, 2017

NelleV commented Mar 24, 2017

QuLogic commented Mar 25, 2017

dstansby commented Mar 25, 2017

phobson commented Mar 26, 2017


		explode: [ None \| len(x) sequence ]
		explode : array-like, optional (default is None)

DOC: Clean up the pie docstring PR #8371

DOC: Clean up the pie docstring PR #8371

Conversation

phobson commented Mar 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NelleV left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phobson commented Mar 24, 2017

NelleV commented Mar 24, 2017 • edited Loading

phobson commented Mar 24, 2017

NelleV commented Mar 24, 2017

phobson commented Mar 24, 2017

QuLogic commented Mar 24, 2017 • edited Loading

phobson commented Mar 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NelleV commented Mar 24, 2017

QuLogic commented Mar 25, 2017

dstansby commented Mar 25, 2017

phobson commented Mar 26, 2017

NelleV commented Mar 24, 2017 •

edited

Loading

QuLogic commented Mar 24, 2017 •

edited

Loading