rst seealso -> numpydoc "See Also".

anntzer · anntzer · commit 38a35b73dde2 · 2019-04-05T11:34:24.000+02:00
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -41,11 +41,10 @@ def _process_plot_format(fmt):
     * 'r--': red dashed lines
     * 'C2--': the third color in the color cycle, dashed lines
 
-    .. seealso::
-
-        :func:`~matplotlib.Line2D.lineStyles` and
-        :attr:`~matplotlib.colors.cnames`
-            for all possible styles and color format string.
+    See Also
+    --------
+    matplotlib.Line2D.lineStyles, matplotlib.colors.cnames
+        All possible styles and color format strings.
     """
 
     linestyle = None
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -636,14 +636,14 @@ def set_color(self, c):
         """
         Set both the edgecolor and the facecolor.
 
-        .. seealso::
-
-            :meth:`set_facecolor`, :meth:`set_edgecolor`
-               For setting the edge or face color individually.
-
         Parameters
         ----------
-        c : matplotlib color arg or sequence of rgba tuples
+        c : color or sequence of rgba tuples
+
+        See Also
+        --------
+        Collection.set_facecolor, Collection.set_edgecolor
+            For setting the edge or face color individually.
         """
         self.set_facecolor(c)
         self.set_edgecolor(c)
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -579,31 +579,34 @@ def reversed(self, name=None):
         """
         Make a reversed instance of the Colormap.
 
-        .. note :: Function not implemented for base class.
+        .. note:: Function not implemented for base class.
 
         Parameters
         ----------
         name : str, optional
             The name for the reversed colormap. If it's None the
             name will be the name of the parent colormap + "_r".
 
-        Notes
-        -----
-        See :meth:`LinearSegmentedColormap.reversed` and
-        :meth:`ListedColormap.reversed`
+        See Also
+        --------
+        LinearSegmentedColormap.reversed
+        ListedColormap.reversed
         """
         raise NotImplementedError()
 
 
 class LinearSegmentedColormap(Colormap):
-    """Colormap objects based on lookup tables using linear segments.
+    """
+    Colormap objects based on lookup tables using linear segments.
 
     The lookup table is generated using linear interpolation for each
     primary color, with the 0-1 domain divided into any number of
     segments.
     """
+
     def __init__(self, name, segmentdata, N=256, gamma=1.0):
-        """Create color map from linear mapping segments
+        """
+        Create color map from linear mapping segments
 
         segmentdata argument is a dictionary with a red, green and blue
         entries. Each entry should be a list of *x*, *y0*, *y1* tuples,
@@ -639,15 +642,14 @@ def __init__(self, name, segmentdata, N=256, gamma=1.0):
 
         Hence y0 in the first row and y1 in the last row are never used.
 
+        See Also
+        --------
+        LinearSegmentedColormap.from_list
+            Static method; factory function for generating a smoothly-varying
+            LinearSegmentedColormap.
 
-        .. seealso::
-
-               :meth:`LinearSegmentedColormap.from_list`
-               Static method; factory function for generating a
-               smoothly-varying LinearSegmentedColormap.
-
-               :func:`makeMappingArray`
-               For information about making a mapping array.
+        makeMappingArray
+            For information about making a mapping array.
         """
         # True only if all colors in map are identical; needed for contouring.
         self.monochrome = False
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -314,14 +314,14 @@ def set_color(self, c):
         """
         Set both the edgecolor and the facecolor.
 
-        .. seealso::
-
-            :meth:`set_facecolor`, :meth:`set_edgecolor`
-               For setting the edge or face color individually.
-
         Parameters
         ----------
         c : color
+
+        See Also
+        --------
+        Patch.set_facecolor, Patch.set_edgecolor
+            For setting the edge or face color individually.
         """
         self.set_facecolor(c)
         self.set_edgecolor(c)
@@ -927,12 +927,6 @@ def __init__(self, path, **kwargs):
 
         Valid kwargs are:
         %(Patch)s
-
-        .. seealso::
-
-            :class:`Patch`
-                For additional kwargs
-
         """
         Patch.__init__(self, **kwargs)
         self._path = path
@@ -959,12 +953,6 @@ def __init__(self, xy, closed=True, **kwargs):
 
         Valid kwargs are:
         %(Patch)s
-
-        .. seealso::
-
-            :class:`Patch`
-                For additional kwargs
-
         """
         Patch.__init__(self, **kwargs)
         self._closed = closed
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -420,16 +420,12 @@ def cleaned(self, transform=None, remove_nans=False, clip=None,
                 quantize=False, simplify=False, curves=False,
                 stroke_width=1.0, snap=False, sketch=None):
         """
-        Cleans up the path according to the parameters returning a new
-        Path instance.
+        Returns a new Path after cleaning vertices and codes according to the
+        parameters.
 
-        .. seealso::
-
-            See :meth:`iter_segments` for details of the keyword arguments.
-
-        Returns
-        -------
-        Path instance with cleaned up vertices and codes.
+        See Also
+        --------
+        Path.iter_segments : for details of the keyword arguments.
         """
         vertices, codes = _path.cleanup_path(
             self, transform, remove_nans, clip, snap, stroke_width, simplify,
@@ -443,12 +439,11 @@ def transformed(self, transform):
         """
         Return a transformed copy of the path.
 
-        .. seealso::
-
-            :class:`matplotlib.transforms.TransformedPath`
-                A specialized path class that will cache the
-                transformed result and automatically update when the
-                transform changes.
+        See Also
+        --------
+        matplotlib.transforms.TransformedPath
+            A specialized path class that will cache the transformed result and
+            automatically update when the transform changes.
         """
         return Path(transform.transform(self.vertices), self.codes,
                     self._interpolation_steps)
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1210,15 +1210,13 @@ def subplot2grid(shape, loc, rowspan=1, colspan=1, fig=None, **kwargs):
 
 def twinx(ax=None):
     """
-    Make a second axes that shares the *x*-axis.  The new axes will
-    overlay *ax* (or the current axes if *ax* is *None*).  The ticks
-    for *ax2* will be placed on the right, and the *ax2* instance is
-    returned.
-
-    .. seealso::
-
-       :doc:`/gallery/subplots_axes_and_figures/two_scales`
+    Make and return a second axes that shares the *x*-axis.  The new axes will
+    overlay *ax* (or the current axes if *ax* is *None*), and its ticks will be
+    on the right.
 
+    Examples
+    --------
+    :doc:`/gallery/subplots_axes_and_figures/two_scales`
     """
     if ax is None:
         ax = gca()
@@ -1228,10 +1226,13 @@ def twinx(ax=None):
 
 def twiny(ax=None):
     """
-    Make a second axes that shares the *y*-axis.  The new axis will
-    overlay *ax* (or the current axes if *ax* is *None*).  The ticks
-    for *ax2* will be placed on the top, and the *ax2* instance is
-    returned.
+    Make and return a second axes that shares the *y*-axis.  The new axes will
+    overlay *ax* (or the current axes if *ax* is *None*), and its ticks will be
+    on the top.
+
+    Examples
+    --------
+    :doc:`/gallery/subplots_axes_and_figures/two_scales`
     """
     if ax is None:
         ax = gca()
diff --git a/lib/matplotlib/sankey.py b/lib/matplotlib/sankey.py
@@ -109,15 +109,15 @@ def __init__(self, ax=None, scale=1.0, unit='', format='%G', gap=0.25,
 
             Sankey().add().add...  .add().finish()
 
-        .. seealso::
-
-            :meth:`add`
-            :meth:`finish`
-
+        See Also
+        --------
+        Sankey.add
+        Sankey.finish
 
-        **Examples:**
+        Examples
+        --------
 
-            .. plot:: gallery/specialty_plots/sankey_basics.py
+        .. plot:: gallery/specialty_plots/sankey_basics.py
         """
         # Check the arguments.
         if gap < 0:
@@ -807,9 +807,9 @@ def finish(self):
                             for the labels of flows
           ===============   ===================================================
 
-        .. seealso::
-
-            :meth:`add`
+        See Also
+        --------
+        Sankey.add
         """
         self.ax.axis([self.extent[0] - self.margin,
                       self.extent[1] + self.margin,
diff --git a/lib/matplotlib/spines.py b/lib/matplotlib/spines.py
@@ -582,14 +582,13 @@ def set_color(self, c):
 
         Parameters
         ----------
-        c : color or sequence of rgba tuples
+        c : color
 
-        .. seealso::
-
-            :meth:`set_facecolor`, :meth:`set_edgecolor`
-               For setting the edge or face color individually.
+        Notes
+        -----
+        This method does not modify the facecolor (which defaults to "none"),
+        unlike the `Patch.set_color` method defined in the parent class.  Use
+        `Patch.set_facecolor` to set the facecolor.
         """
-        # The facecolor of a spine is always 'none' by default -- let
-        # the user change it manually if desired.
         self.set_edgecolor(c)
         self.stale = True
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -593,7 +593,9 @@ def set_scientific(self, b):
         """
         Turn scientific notation on or off.
 
-        .. seealso:: Method :meth:`set_powerlimits`
+        See Also
+        --------
+        ScalarFormatter.set_powerlimits
         """
         self._scientific = bool(b)
 
@@ -612,7 +614,9 @@ def set_powerlimits(self, lims):
             pre-2007 default in which scientific notation is used for
             numbers less than 1e-3 or greater than 1e4.
 
-        .. seealso:: Method :meth:`set_scientific`
+        See Also
+        --------
+        ScalarFormatter.set_scientific
         """
         if len(lims) != 2:
             raise ValueError("'lims' must be a sequence of length 2")
