Improve docstrings of pyplot axis-related functions #10296

timhoffm · 2018-01-23T00:58:24Z

PR Summary

This PR improves th docstrings of pyplot axis-related functions:

x/yscale
x/ylim
x/ylabel
x/yticks

timhoffm · 2018-02-01T20:59:50Z

The failing test is something about latex. Since I've only changed docstring, it must be unrelated to the PR.

jklymak · 2018-02-01T21:06:40Z

Yes if you rebase it’ll pick up the latex fix. But this could pass w/o it.

timhoffm · 2018-02-01T21:33:43Z

rebased.

QuLogic · 2018-02-04T20:27:42Z

lib/matplotlib/pyplot.py


-      xticks( arange(12), calendar.month_name[1:13], rotation=17 )
+    **kwargs
+        :class:`.Text` properties can be used to control the appearence of


QuLogic · 2018-02-04T20:27:56Z

lib/matplotlib/pyplot.py

+        an empty list to disable ticks and labels.
+
+    **kwargs
+        :class:`.Text` properties can be used to control the appearence of


QuLogic · 2018-02-04T20:29:19Z

lib/matplotlib/pyplot.py

+
+        >>> xticks(np.arange(5), ('Tom', 'Dick', 'Harry', 'Sally', 'Sue'))
+
+


Add heading Set text labels and properties:?

QuLogic · 2018-02-04T20:30:27Z

lib/matplotlib/pyplot.py

-    properties. For example, to rotate long labels::
+    labels : array_like, optional
+        A list of explicit labels to place at the given *locs*. You can pass
+        an empty list to disable ticks and labels.


Is the empty list for labels or locs? The example below passes it as the first parameter (locs).

QuLogic · 2018-02-04T20:31:04Z

lib/matplotlib/pyplot.py


-      # set the locations of the yticks
-      yticks( arange(6) )



Add heading Set text labels and properties:?

QuLogic

A couple minor typos.

QuLogic · 2018-02-12T07:23:22Z

lib/matplotlib/pyplot.py

-    The keyword args, if any, are :class:`~matplotlib.text.Text`
-    properties. For example, to rotate long labels::
+    labels : array_like, optional
+        A list of explicit labels to place the the given *locs*.


the the -> at the

QuLogic · 2018-02-12T07:23:33Z

lib/matplotlib/pyplot.py

+        empty list to disable yticks.
+
+    labels : array_like, optional
+        A list of explicit labels to place the the given *locs*.


the the -> at the

WeatherGod · 2018-02-12T16:00:38Z

You should also updated the corresponding `z` functions in mplot3d so that they match up.

…

On Mon, Feb 12, 2018 at 2:24 AM, Elliott Sales de Andrade < ***@***.***> wrote: ***@***.**** commented on this pull request. A couple minor typos. ------------------------------ In lib/matplotlib/pyplot.py <#10296 (comment)> : > - The keyword args, if any, are :class:`~matplotlib.text.Text` - properties. For example, to rotate long labels:: + labels : array_like, optional + A list of explicit labels to place the the given *locs*. the the -> at the ------------------------------ In lib/matplotlib/pyplot.py <#10296 (comment)> : > + Get or set the current tick locations and labels of the y-axis. + + Call signatures:: + + locs, labels = yticks() # Get locations and labels + + yticks(locs, [labels], **kwargs) # Set locations and labels + + Parameters + ---------- + locs : array_like + A list of positions at which ticks should be placed. You can pass an + empty list to disable yticks. + + labels : array_like, optional + A list of explicit labels to place the the given *locs*. the the -> at the — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#10296 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AARy-I7RRDWe_xchKxRlMPkayfWpcvU6ks5tT-cXgaJpZM4Ro5iC> .

timhoffm · 2018-02-13T00:28:59Z

@WeatherGod updating the z functions is not trivial for a bunch of reasons, because the have some differences. I would rather tackle these in a separate pull request.

story645

I love more clear reviews, I just think the docs should clearly distinguish these are the methods for the pyplot interface and these are their pyplot equivalents.

story645 · 2018-02-13T00:41:42Z

lib/matplotlib/pyplot.py


-        :func:`~matplotlib.pyplot.text`
-            For information on how override and the optional args work
+    This is just a shortcut for calling `.set_xlabel` on the current axes.


I feel like this implies that either ax.xlabel or plt.set_xlabel valid.
Alternative suggestion is something like: this is the pyplot interface equivalent of calling :method:~matplotlib.axes.Axes.set_xlabelon the current axes.

story645 · 2018-02-13T00:47:22Z

lib/matplotlib/pyplot.py


-    If you do not specify args, you can pass the xmin and xmax as
-    kwargs, e.g.::
+    If you do not specify args, you can alternatively pass *xmin* or *xmax* as


I think the alternatively is clearly implied here

story645 · 2018-02-13T00:57:26Z

lib/matplotlib/pyplot.py


+    Notes
+    -----
+    This is just a shortcut for calling `~.Axes.get_xlim` or `~.Axes.set_xlim`


Same as set_xlabel/set_ylable comment. Calling this function with no arguments (e.g. xlim()) is the pyplot equivalent of calling ~.Axes.get_xlim on the current axis. Calling this function with arguments (e.g. xlim(xmin=3, xmax=5) is the pyplot equivalent of calling ~.Axes.set_xlim on the current axis.

anntzer

pending CI

tacaswell · 2018-03-16T02:05:12Z

The mac failure is due to homebrew changing how python3 installs

Backport PR #10296 on branch v2.2.x

timhoffm force-pushed the pyplot-doc-xysettings branch from 00ea6e8 to 1ea95c7 Compare January 24, 2018 01:54

timhoffm added the Documentation label Jan 24, 2018

timhoffm added this to the v2.2 milestone Jan 24, 2018

timhoffm force-pushed the pyplot-doc-xysettings branch from 1ea95c7 to 93118f9 Compare January 29, 2018 23:07

timhoffm requested a review from dstansby February 1, 2018 21:00

timhoffm force-pushed the pyplot-doc-xysettings branch from 93118f9 to ba8c366 Compare February 1, 2018 21:33

QuLogic reviewed Feb 4, 2018

View reviewed changes

timhoffm force-pushed the pyplot-doc-xysettings branch from ba8c366 to 571785e Compare February 4, 2018 23:20

QuLogic reviewed Feb 12, 2018

View reviewed changes

timhoffm force-pushed the pyplot-doc-xysettings branch from 571785e to 477a055 Compare February 13, 2018 00:13

story645 reviewed Feb 13, 2018

View reviewed changes

timhoffm force-pushed the pyplot-doc-xysettings branch from 477a055 to d4b968b Compare February 13, 2018 22:52

timhoffm force-pushed the pyplot-doc-xysettings branch from d4b968b to c05da63 Compare February 24, 2018 20:05

anntzer approved these changes Feb 24, 2018

View reviewed changes

timhoffm force-pushed the pyplot-doc-xysettings branch from c05da63 to 5e0d81e Compare February 25, 2018 17:47

timhoffm added 4 commits March 3, 2018 12:54

improve docstrings of pyplot.xticks and pyplot.yticks

e9163a8

improve docstrings of pyplot.xlim and pyplot.ylim

fd33d87

improve docstrings of pyplot.xlabel and pyplot.ylabel

7ad7c62

improve docstrings of pyplot.xscale and pyplot.yscale

6f28a57

timhoffm force-pushed the pyplot-doc-xysettings branch from 5e0d81e to 6f28a57 Compare March 3, 2018 11:54

timhoffm modified the milestones: needs sorting, v2.2-doc Mar 6, 2018

timhoffm added the status: needs review label Mar 16, 2018

tacaswell modified the milestones: v2.2-doc, v2.2.1 Mar 16, 2018

tacaswell merged commit cc7d086 into matplotlib:master Mar 16, 2018

lumberbot-app bot pushed a commit that referenced this pull request Mar 16, 2018

Backport PR #10296: Improve docstrings of pyplot axis-related functions

798db39

lumberbot-app bot mentioned this pull request Mar 16, 2018

Backport PR #10296 on branch v2.2.x #10808

Merged

timhoffm added a commit that referenced this pull request Mar 16, 2018

Merge pull request #10808 from matplotlib/auto-backport-of-pr-10296

fb6e599

Backport PR #10296 on branch v2.2.x

timhoffm removed the status: needs review label Mar 18, 2018

timhoffm deleted the pyplot-doc-xysettings branch March 18, 2018 00:10


		>>> xticks(np.arange(5), ('Tom', 'Dick', 'Harry', 'Sally', 'Sue'))

Uh oh!

Improve docstrings of pyplot axis-related functions #10296

Improve docstrings of pyplot axis-related functions #10296

Uh oh!

Conversation

timhoffm commented Jan 23, 2018

PR Summary

Uh oh!

timhoffm commented Feb 1, 2018

Uh oh!

jklymak commented Feb 1, 2018

Uh oh!

timhoffm commented Feb 1, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WeatherGod commented Feb 12, 2018 via email

Uh oh!

timhoffm commented Feb 13, 2018

Uh oh!

story645 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anntzer left a comment

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Mar 16, 2018

Uh oh!

Uh oh!