DOC Updated parameters to numpy format #7036

djarecka · 2016-09-05T15:27:58Z

WIP: Updating documentation of the pcolor function in _axes.py.
Updates to Parameters
TODO: Returns, Examples, etc.

QuLogic · 2016-09-06T04:51:55Z

Your commit is currently attributed to "djarecka". It is your choice whether to use a real name or not, of course, but I'm making a note of it just in case.

NelleV · 2016-09-06T08:34:27Z

Note for reviewers: this is still work in progress.

NelleV · 2016-09-06T08:36:19Z

lib/matplotlib/axes/_axes.py

+            Y coordinates of the colored quadrilaterals.
+        cmap : `~matplotlib.colors.Colormap`, optional, default: None
+            If `None`, default to rc settings.
+        norm :`matplotlib.colors.Normalize`, optional, default: None 


There is trailing whitespace at the end of this line. Can you please remove it?

QuLogic · 2016-09-06T21:29:43Z

Your last two commits do not have a name set and are currently attributed to "Your Name you@example.com", which is probably not what you want.

NelleV · 2016-10-17T17:10:12Z

Hi @djarecka
I remember you expressed interest in pursuing the work for this PR. Are you still interested?
Thanks,

djarecka · 2016-10-17T17:44:55Z

Hi @NelleV
I'm sorry, it just at the end I still had some problems with my matplotlib and couldn't see my changes in the documentation. Later I was traveling and completely forgot. I'll try to install sphinx and build documentation on my new computer or finish the PR without it. Will do it this week!

QuLogic · 2016-10-23T22:38:33Z

Are you familiar with rebasing and willing to fix the name on the previous two commits? If not, just tick the checkbox on the right column for "Allow edits from maintainers" and we can do that for you.

djarecka · 2016-10-23T22:43:42Z

@QuLogic , never done rebasing, but let me read and try. However, I'll finish my changes in documentation first.

NelleV

Thanks so much for continuing this work!

Overall, it looks good. I've underline two small problems that prevents the documentation from building properly. I think it should work fine once you fix those (thought we will have to check).

NelleV · 2016-10-27T15:13:26Z

lib/matplotlib/axes/_axes.py

+        -------
+        kwargs : `~matplotlib.collections.PolyCollection` properties:
+
+        %(PolyCollection)s


Can you remove this line? We have decided to move away from docstring interpolation. It should also fix the build problem.

NelleV · 2016-10-27T15:15:11Z

lib/matplotlib/axes/_axes.py

+
+        %(PolyCollection)s
+
+        The default `antialiaseds` is False if the default


We also need to have that part as a "numpydoc" argument style:

antialiaseds : bool, optional, default: False blah blah blah

Hi @NelleV , thanks for suggestions. I've been testing this doc a bit on a private branch, but had problems with understanding the problem. Did you mean removing the line 5259 with %(PolyCollection)s. I did it, but didn't help and I saw it in other parts of the file. Will try to test it more during weekend, but if you have other suggestion, I'm happy to try.

QuLogic

Let us know if you want to do the rebase yourself to correct the names.

djarecka · 2016-12-12T03:20:43Z

@QuLogic I guess my bigger problem is that I'm still getting errors... I tested a few things today on a different branch, but didn't learn anything interesting. If you know what is wrong and how to fix it, that would be great.

QuLogic · 2017-02-25T09:40:58Z

lib/matplotlib/axes/_axes.py

-        details, see the :ref:`Grid Orientation
-        <axes-pcolor-grid-orientation>` section below.
+        pcolor can be very slow for large arrays; consider
+          using the similar but much faster


The problem is that this line is indented and it confuses sphinx; aligning it with the previous line should fix it.

QuLogic · 2017-02-25T09:41:30Z

lib/matplotlib/axes/_axes.py

+            An array of color values.
+
+        X, Y : array_like, optional
+          If given, specify the (x, y) coordinates of


Please stick to 4-space indent.

dstansby · 2017-07-28T11:57:39Z

Hi @djarecka, I have fixed the last couple of things that should make the doc build work - it took me a while to fix everything, so I'm not surprised you had problems. Hopefully if the doc build passes a couple of us can review this and get it merged - thanks for the PR!

djarecka · 2017-07-28T19:30:32Z

@dstansby - thank you for fixing!

QuLogic

There are some rendering issues, noted below. If you rebase, please fix the name on the commit.

QuLogic · 2017-07-28T20:22:51Z

lib/matplotlib/axes/_axes.py

-            An :class:`matplotlib.colors.Normalize` instance is used
-            to scale luminance data to 0,1. If *None*, defaults to
-            :func:`normalize`.
+        norm :`matplotlib.colors.Normalize`, optional, default: None


Space after colon.

QuLogic · 2017-07-28T20:23:20Z

lib/matplotlib/axes/_axes.py

+        Other Parameters
+        ----------------
+        antialiaseds : bool, optional, default: False
+            The default `antialiaseds` is False if the default


Double-backticks (can't reference parameters)

QuLogic · 2017-07-28T20:24:05Z

lib/matplotlib/axes/_axes.py

+        ----------------
+        antialiaseds : bool, optional, default: False
+            The default `antialiaseds` is False if the default
+            `edgecolors`="none" is used.  This eliminates artificial lines


Using a backtick in the middle of a word doesn't close the reference. In any case, should be double-backticks because you can't reference parameters.

QuLogic · 2017-07-28T20:25:36Z

lib/matplotlib/axes/_axes.py

+            Stroking the edges may be preferred if `alpha` is 1, but
+            will cause artifacts otherwise.
+
+        kwargs : `~matplotlib.collections.PolyCollection`


This is not quite correct; any remaining **kwargs are sent to PolyCollection. kwargs is not expected to be a PolyCollection type object.

Fix whitespace Fix whitespace

References don't work to function parameters.

Made changes

QuLogic · 2017-07-29T06:53:55Z

I fixed the formatting stuff and updated the commit author; this can probably be squash-merged.

mdboom added the status: needs review label Sep 5, 2016

QuLogic added the Documentation label Sep 6, 2016

NelleV reviewed Sep 6, 2016
View reviewed changes

djarecka force-pushed the pcolor_numpydoc branch from 910a18b to 82a4ef1 Compare September 10, 2016 16:08

tacaswell added this to the 2.0.1 (next bug fix release) milestone Sep 24, 2016

tacaswell added status: needs revision and removed status: needs review labels Sep 24, 2016

NelleV requested changes Oct 27, 2016

View reviewed changes

djarecka force-pushed the pcolor_numpydoc branch from 9916765 to 3a016f7 Compare December 11, 2016 02:01

QuLogic previously requested changes Dec 11, 2016

View reviewed changes

NelleV modified the milestones: 2.1 (next point release), 2.0.1 (next bug fix release) Dec 17, 2016

QuLogic reviewed Feb 25, 2017

View reviewed changes

dstansby self-assigned this Jul 28, 2017

dstansby force-pushed the pcolor_numpydoc branch from 6d4f142 to c2031fe Compare July 28, 2017 11:56

QuLogic reviewed Jul 28, 2017

View reviewed changes

djarecka and others added 10 commits July 29, 2017 01:30

WIP DOC Updated parameters to numpy format

431e6d4

changing doc

b0b3745

pcolor: doc updated to the NumPy format

424cd76

removing * from the note section

4d333a3

trying to fix the documentation: removing %(PolyCollection)s

8c041a8

changes in Other Parameters

f55a68f

fixing previous commmit, removing trailing spaces

e78b161

Fix whitespace

943eccb

Fix whitespace Fix whitespace

Use inline-code instead of references.

59e0a80

References don't work to function parameters.

Add description of remaining pcolor kwargs.

6ce0bc8

QuLogic force-pushed the pcolor_numpydoc branch from c2031fe to 6ce0bc8 Compare July 29, 2017 06:52

QuLogic removed the status: needs revision label Jul 29, 2017

QuLogic changed the title ~~[WIP] DOC Updated parameters to numpy format~~ DOC Updated parameters to numpy format Jul 29, 2017

dstansby approved these changes Jul 29, 2017

View reviewed changes

QuLogic merged commit 189cb98 into matplotlib:master Jul 30, 2017

dstansby removed their assignment Jul 31, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC Updated parameters to numpy format #7036

DOC Updated parameters to numpy format #7036

djarecka commented Sep 5, 2016

QuLogic commented Sep 6, 2016

NelleV commented Sep 6, 2016

NelleV Sep 6, 2016

QuLogic commented Sep 6, 2016

NelleV commented Oct 17, 2016

djarecka commented Oct 17, 2016

QuLogic commented Oct 23, 2016

djarecka commented Oct 23, 2016

NelleV left a comment

NelleV Oct 27, 2016

NelleV Oct 27, 2016

djarecka Oct 28, 2016

QuLogic left a comment

djarecka commented Dec 12, 2016

QuLogic Feb 25, 2017

QuLogic Feb 25, 2017

dstansby commented Jul 28, 2017

djarecka commented Jul 28, 2017

QuLogic left a comment

QuLogic Jul 28, 2017

QuLogic Jul 28, 2017

QuLogic Jul 28, 2017

QuLogic Jul 28, 2017

QuLogic commented Jul 29, 2017 •

edited

Loading


		%(PolyCollection)s

		The default `antialiaseds` is False if the default

DOC Updated parameters to numpy format #7036

DOC Updated parameters to numpy format #7036

Conversation

djarecka commented Sep 5, 2016

QuLogic commented Sep 6, 2016

NelleV commented Sep 6, 2016

Choose a reason for hiding this comment

QuLogic commented Sep 6, 2016

NelleV commented Oct 17, 2016

djarecka commented Oct 17, 2016

QuLogic commented Oct 23, 2016

djarecka commented Oct 23, 2016

NelleV left a 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

QuLogic left a comment

Choose a reason for hiding this comment

djarecka commented Dec 12, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dstansby commented Jul 28, 2017

djarecka commented Jul 28, 2017

QuLogic left a 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

QuLogic commented Jul 29, 2017 • edited Loading

QuLogic commented Jul 29, 2017 •

edited

Loading