DOC: Fix ordering of Examples in docstrings.

QuLogic · QuLogic · commit 0b18183f3ca1 · 2020-03-20T17:24:37.000-04:00
As noted before, the ordering for numpydoc is required, so Examples
should be last.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -863,6 +863,12 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
 
             %(_Line2D_docstr)s
 
+        See Also
+        --------
+        vlines : Add vertical lines in data coordinates.
+        axvspan : Add a vertical span (rectangle) across the axis.
+        axline : Add a line with an abritrary slope.
+
         Examples
         --------
         * draw a thick red vline at *x* = 0 that spans the yrange::
@@ -877,12 +883,6 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
           the yrange::
 
             >>> axvline(x=.5, ymin=0.25, ymax=0.75)
-
-        See also
-        --------
-        vlines : Add vertical lines in data coordinates.
-        axvspan : Add a vertical span (rectangle) across the axis.
-        axline : Add a line with an abritrary slope.
         """
 
         if "transform" in kwargs:
@@ -929,16 +929,16 @@ def axline(self, xy1, xy2, **kwargs):
 
             %(_Line2D_docstr)s
 
+        See Also
+        --------
+        axhline : for horizontal lines
+        axvline : for vertical lines
+
         Examples
         --------
         Draw a thick red line passing through (0, 0) and (1, 1)::
 
             >>> axline((0, 0), (1, 1), linewidth=4, color='r')
-
-        See Also
-        --------
-        axhline : for horizontal lines
-        axvline : for vertical lines
         """
 
         if "transform" in kwargs:
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1175,6 +1175,13 @@ def set_prop_cycle(self, *args, **kwargs):
             Finite-length iterable of the property values. These values
             are validated and will raise a ValueError if invalid.
 
+        See Also
+        --------
+        matplotlib.rcsetup.cycler
+            Convenience function for creating validated cyclers for properties.
+        cycler.cycler
+            The original function for creating unvalidated cyclers.
+
         Examples
         --------
         Setting the property cycle for a single property:
@@ -1187,13 +1194,6 @@ def set_prop_cycle(self, *args, **kwargs):
         >>> ax.set_prop_cycle(color=['red', 'green', 'blue'],
         ...                   marker=['o', '+', 'x'])
 
-        See Also
-        --------
-        matplotlib.rcsetup.cycler
-            Convenience function for creating validated cyclers for properties.
-        cycler.cycler
-            The original function for creating unvalidated cyclers.
-
         """
         if args and kwargs:
             raise TypeError("Cannot supply both positional and keyword "
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1479,6 +1479,12 @@ def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
             dimensions of the resulting array can be controlled with the
             squeeze keyword, see above.
 
+        See Also
+        --------
+        .pyplot.subplots
+        .Figure.add_subplot
+        .pyplot.subplot
+
         Examples
         --------
         ::
@@ -1517,12 +1523,6 @@ def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
 
             # Note that this is the same as
             fig.subplots(2, 2, sharex=True, sharey=True)
-
-        See Also
-        --------
-        .pyplot.subplots
-        .Figure.add_subplot
-        .pyplot.subplot
         """
 
         if isinstance(sharex, bool):
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1112,6 +1112,14 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
         because for the latter it's not clear if it refers to a single
         `~.axes.Axes` instance or a collection of these.
 
+    See Also
+    --------
+    .pyplot.figure
+    .pyplot.subplot
+    .pyplot.axes
+    .Figure.subplots
+    .Figure.add_subplot
+
     Examples
     --------
     ::
@@ -1152,14 +1160,6 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
         # and clears it if it already exists.
         fig, ax = plt.subplots(num=10, clear=True)
 
-    See Also
-    --------
-    .pyplot.figure
-    .pyplot.subplot
-    .pyplot.axes
-    .Figure.subplots
-    .Figure.add_subplot
-
     """
     fig = figure(**fig_kw)
     axs = fig.subplots(nrows=nrows, ncols=ncols, sharex=sharex, sharey=sharey,
@@ -1570,6 +1570,13 @@ def rgrids(*args, **kwargs):
     **kwargs
         *kwargs* are optional `~.Text` properties for the labels.
 
+    See Also
+    --------
+    .pyplot.thetagrids
+    .projections.polar.PolarAxes.set_rgrids
+    .Axis.get_gridlines
+    .Axis.get_ticklabels
+
     Examples
     --------
     ::
@@ -1579,13 +1586,6 @@ def rgrids(*args, **kwargs):
 
       # set the locations and labels of the radial gridlines
       lines, labels = rgrids( (0.25, 0.5, 1.0), ('Tom', 'Dick', 'Harry' ))
-
-    See Also
-    --------
-    .pyplot.thetagrids
-    .projections.polar.PolarAxes.set_rgrids
-    .Axis.get_gridlines
-    .Axis.get_ticklabels
     """
     ax = gca()
     if not isinstance(ax, PolarAxes):
@@ -1634,6 +1634,13 @@ def thetagrids(*args, **kwargs):
     **kwargs
         *kwargs* are optional `~.Text` properties for the labels.
 
+    See Also
+    --------
+    .pyplot.rgrids
+    .projections.polar.PolarAxes.set_thetagrids
+    .Axis.get_gridlines
+    .Axis.get_ticklabels
+
     Examples
     --------
     ::
@@ -1643,13 +1650,6 @@ def thetagrids(*args, **kwargs):
 
       # set the locations and labels of the angular gridlines
       lines, labels = thetagrids(range(45, 360, 90), ('NE', 'NW', 'SW', 'SE'))
-
-    See Also
-    --------
-    .pyplot.rgrids
-    .projections.polar.PolarAxes.set_thetagrids
-    .Axis.get_gridlines
-    .Axis.get_ticklabels
     """
     ax = gca()
     if not isinstance(ax, PolarAxes):
