Numpy Doc Format #7424

sirlittle · 2016-11-08T03:00:21Z

Changed some documentation to be in Numpy Doc format for set_xlim, set_ylim, etc. Also removed extra line from the documentation.

twmr · 2016-11-08T03:03:43Z

lib/matplotlib/axes/_axes.py

@@ -3796,7 +3796,7 @@ def dopatch(xs, ys, **kwargs):
    def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
                vmin=None, vmax=None, alpha=None, linewidths=None,
                verts=None, edgecolors=None,
-                **kwargs):
+                **kx`wargs):


accidentally commited?

tacaswell · 2016-11-08T03:06:30Z

lib/matplotlib/axes/_base.py

@@ -2800,7 +2800,9 @@ def get_xlim(self):
        return tuple(self.viewLim.intervalx)

    def set_xlim(self, left=None, right=None, emit=True, auto=False, **kw):
-        """
+        """ 
+        set_xlim(self, left, right, emit, auto, **kwargs)


@NelleV haven't we been removing these because they are redundent?

Yes, I removed as many as I could without losing information; please don't add them back.

tacaswell · 2016-11-08T03:08:55Z

Something funny went on with that merge from master. Can you try re-basing this on top of current master See http://matplotlib.org/devdocs/devel/gitwash/development_workflow.html?highlight=rebase#rebasing-a-pull-request-pr

Please ping me if you need more help with rebasing.

QuLogic · 2016-11-08T21:01:13Z

lib/matplotlib/axes/_axes.py

@@ -3796,7 +3796,7 @@ def dopatch(xs, ys, **kwargs):
    def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
                vmin=None, vmax=None, alpha=None, linewidths=None,
                verts=None, edgecolors=None,
-                **kwargs):
+                **kxwargs):


It's kwargs.

If possible, please squash that last commit (and any others modifying this line) into the second commit.

QuLogic · 2016-11-15T07:57:23Z

doc/users/mathtext.rst

@@ -214,6 +214,11 @@ When using the `STIX <http://www.stixfonts.org/>`_ fonts, you also have the choi
    ``\mathfrak{Fraktur}``                 :math-stix:`\mathfrak{Fraktur}`
    ``\mathsf{sansserif}``                 :math-stix:`\mathsf{sansserif}`
    ``\mathrm{\mathsf{sansserif}}``        :math-stix:`\mathrm{\mathsf{sansserif}}`
+    ====================================== =========================================    
+
+  .. htmlonly::   


This commit reverts the first commit and adds a bunch of trailing whitespace.

NelleV · 2016-11-15T17:33:49Z

This looks good, but next time please open a new pull request for each ticket you fix.
Can you also add the list of tickets this PR closes?

sirlittle · 2016-11-15T19:15:04Z

This pull request is supposed to solve #7205 and #7388.

QuLogic

Small typos and such.

QuLogic · 2016-11-15T08:15:11Z

examples/misc/multiprocess.py

@@ -2,6 +2,7 @@
 # Demo of using multiprocessing for generating data in one process and plotting
 # in another.
 # Written by Robert Cimrman
+from six.moves import input

 from __future__ import print_function


__future__ imports must be the first line of code in the file; the six import belongs after it.

QuLogic · 2016-11-15T08:15:43Z

examples/pylab_examples/griddata_demo.py

 # make up data.
-#npts = int(raw_input('enter # of random points to plot:'))
+#npts = int(input('enter # of random points to plot:'))


Might as well just remove this line instead (and the six import can be dropped.)

QuLogic · 2016-11-15T08:16:09Z

examples/widgets/lasso_selector_demo.py

@@ -5,6 +5,8 @@
 from matplotlib.widgets import LassoSelector
 from matplotlib.path import Path

+from six.moves import input
+
 try:
    raw_input


This try/except is trying to do the same thing as your six import; it should be removed now.

QuLogic · 2016-11-16T00:39:32Z

doc/users/mathtext.rst

@@ -216,7 +216,7 @@ When using the `STIX <http://www.stixfonts.org/>`_ fonts, you also have the choi
    ``\mathrm{\mathsf{sansserif}}``        :math-stix:`\mathrm{\mathsf{sansserif}}`
    ====================================== =========================================

-.. htmlonly::
+  .. htmlonly::


So you've mostly reverted the first commit, so I'm a bit confused here.

The goal was to revert the first commit. There is a latex header problem (hence the htmlonly).

QuLogic · 2016-11-16T00:40:25Z

lib/matplotlib/axes/_base.py

-        ACCEPTS: [%(scale)s]
+        Parameters
+        ----------
+        value: float


Missing space before the colon.

I don't think this is true at all; it accepts the strings defined here.

QuLogic · 2016-11-16T00:50:10Z

lib/matplotlib/axes/_base.py

-        Return a list of :class:`~matplotlib.text.Text` instances.
+        Returns
+        -------
+        list of str


The description says otherwise.

QuLogic · 2016-11-16T00:51:03Z

lib/matplotlib/axes/_base.py

-        %(Text)s
+        Other Parameters
+        ----------------
+        *kwargs* set the :class:`~matplotlib.text.Text` properties.


A different format than set_xticklabels.

QuLogic · 2016-11-16T00:51:41Z

lib/matplotlib/axes/_base.py

@@ -3868,15 +3884,19 @@ def twinx(self):
        """
        Create a twin Axes sharing the xaxis

-        create a twin of Axes for generating a plot with a sharex
+        Create a twin of Axes for generating a plot with a sharex


sharex -> shared

QuLogic · 2016-11-16T00:51:56Z

lib/matplotlib/axes/_base.py

+        Axis
+            The newly created axis
+
+        For those who are 'picking' artists while using twinx, pick


Needs a Notes heading.

QuLogic · 2016-11-16T00:52:29Z

lib/matplotlib/axes/_base.py

+        Axis
+            The newly created axis
+
+        For those who are 'picking' artists while using twiny, pick


Needs a Notes heading.

NelleV · 2016-11-16T01:58:47Z

Hi @sirlittle
Don't worry about the last elements to be done on this PR. I'll fix them.
On the other hand, please do not push anything onto your remote master branch until this is merged.
Thanks,

codecov-io · 2016-12-18T17:07:34Z

Current coverage is 62.05% (diff: 100%)

Merging #7424 into master will decrease coverage by 4.40%

@@             master      #7424   diff @@
==========================================
  Files           109        174     +65   
  Lines         46766      56147   +9381   
  Methods           0          0           
  Messages          0          0           
  Branches          0          0           
==========================================
+ Hits          31080      34842   +3762   
- Misses        15686      21305   +5619   
  Partials          0          0

Powered by Codecov. Last update 8c5b548...e7b3c31

NelleV · 2016-12-18T18:41:42Z

I suspect the failing test here is unrelated to the patch but it is a test that is failing consistently.

NelleV

LGTM

QuLogic

A couple small typos.

QuLogic · 2016-12-19T23:33:28Z

lib/matplotlib/axes/_base.py

-        Set the scaling of the x-axis: %(scale)s
+        Parameters
+        ----------
+        value : ["linear", "log", "symlog", "logit"]


Should be braces.

QuLogic · 2016-12-19T23:33:39Z

lib/matplotlib/axes/_base.py

+
+        Parameters
+        ----------
+        value : ["linear", "log", "symlog", "logit"]


Braces here, too.

QuLogic · 2016-12-19T23:33:43Z

lib/matplotlib/axes/_base.py

    def set_yticklabels(self, labels, fontdict=None, minor=False, **kwargs):
        """
-        Set the y tick labels with list of strings *labels*
+        Set the xtick labels with list of strings labels


Nice catch.

…ciated functions

…een made in the first place

NelleV · 2017-01-13T23:37:27Z

Comments have been addressed (and I rebase against matplotlib/master and pushed force…).

tacaswell · 2017-01-16T03:49:40Z

Thanks!

twmr reviewed Nov 8, 2016

View reviewed changes

tacaswell reviewed Nov 8, 2016

View reviewed changes

sirlittle force-pushed the master branch from 60bbe9b to 46ca9b3 Compare November 8, 2016 19:40

QuLogic reviewed Nov 8, 2016

View reviewed changes

tacaswell added this to the 2.0.1 (next bug fix release) milestone Nov 9, 2016

tacaswell added the status: needs revision label Nov 9, 2016

sirlittle force-pushed the master branch from 1edf2b3 to 319776f Compare November 13, 2016 22:00

QuLogic reviewed Nov 15, 2016

View reviewed changes

QuLogic reviewed Nov 16, 2016

View reviewed changes

NelleV changed the title ~~Numpy Doc Format~~ [MRG] Numpy Doc Format Nov 29, 2016

NelleV added Documentation and removed status: needs revision labels Nov 29, 2016

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

NelleV force-pushed the master branch 3 times, most recently from 009913b to 3340dcd Compare December 18, 2016 16:57

NelleV force-pushed the master branch from 3340dcd to e7b3c31 Compare December 19, 2016 13:57

NelleV assigned NelleV and sirlittle and unassigned sirlittle Dec 19, 2016

NelleV changed the title ~~[MRG] Numpy Doc Format~~ [MRG+1] Numpy Doc Format Dec 19, 2016

NelleV approved these changes Dec 19, 2016

View reviewed changes

QuLogic reviewed Dec 19, 2016

View reviewed changes

Salil Vanvari and others added 6 commits January 13, 2017 15:31

Fixed extra line

38873bb

Converted documentation to numpy documentation for xlim,ylim and asso…

7517d00

…ciated functions

Squashed commit and removed the excess changes that should not have b…

a481143

…een made in the first place

Examples have been made python3 compliant

3e47ee0

FIX Removed random extra white space and other nitpicks

5b705a0

FIX nitpicks

58f1169

NelleV force-pushed the master branch from e7b3c31 to 58f1169 Compare January 13, 2017 23:33

tacaswell merged commit b6709ea into matplotlib:master Jan 16, 2017

QuLogic changed the title ~~[MRG+1] Numpy Doc Format~~ Numpy Doc Format Jan 16, 2017

Uh oh!

Numpy Doc Format #7424

Numpy Doc Format #7424

Uh oh!

Conversation

sirlittle commented Nov 8, 2016

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!

tacaswell commented Nov 8, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NelleV commented Nov 15, 2016

Uh oh!

sirlittle commented Nov 15, 2016

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!

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!

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!

NelleV commented Nov 16, 2016

Uh oh!

codecov-io commented Dec 18, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Current coverage is 62.05% (diff: 100%)

Uh oh!

NelleV commented Dec 18, 2016

Uh oh!

NelleV left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NelleV commented Jan 13, 2017

Uh oh!

tacaswell commented Jan 16, 2017

Uh oh!

Uh oh!

codecov-io commented Dec 18, 2016 •

edited

Loading