Backport PR #14658: Fix numpydoc formatting

anntzer · MeeseeksDev[bot] · commit 40e0c0c74a69 · 2019-07-17T06:40:25.000Z
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -195,7 +195,7 @@ def setup(self, fig, outfile, dpi=None):
 
         Parameters
         ----------
-        fig : `matplotlib.figure.Figure` instance
+        fig : `~matplotlib.figure.Figure`
             The figure object that contains the information for frames
         outfile : string
             The filename of the resulting movie file
@@ -332,9 +332,9 @@ def setup(self, fig, outfile, dpi=None):
 
         Parameters
         ----------
-        fig : matplotlib.figure.Figure
+        fig : `~matplotlib.figure.Figure`
             The figure object that contains the information for frames
-        outfile : string
+        outfile : str
             The filename of the resulting movie file
         dpi : int, optional
             The DPI (or resolution) for the file.  This controls the size
@@ -442,7 +442,7 @@ def setup(self, fig, outfile, dpi=None, frame_prefix='_tmp',
 
         Parameters
         ----------
-        fig : matplotlib.figure.Figure
+        fig : `~matplotlib.figure.Figure`
             The figure to grab the rendered frames from.
         outfile : str
             The filename of the resulting movie file.
@@ -895,7 +895,7 @@ class Animation(object):
 
     Parameters
     ----------
-    fig : matplotlib.figure.Figure
+    fig : `~matplotlib.figure.Figure`
        The figure object that is used to get draw, resize, and any
        other needed events.
 
@@ -1398,7 +1398,7 @@ class TimedAnimation(Animation):
 
     Parameters
     ----------
-    fig : matplotlib.figure.Figure
+    fig : `~matplotlib.figure.Figure`
        The figure object that is used to get draw, resize, and any
        other needed events.
 
@@ -1481,7 +1481,7 @@ class ArtistAnimation(TimedAnimation):
 
     Parameters
     ----------
-    fig : matplotlib.figure.Figure
+    fig : `~matplotlib.figure.Figure`
        The figure object that is used to get draw, resize, and any
        other needed events.
 
@@ -1558,7 +1558,7 @@ class FuncAnimation(TimedAnimation):
 
     Parameters
     ----------
-    fig : matplotlib.figure.Figure
+    fig : `~matplotlib.figure.Figure`
        The figure object that is used to get draw, resize, and any
        other needed events.
 
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1020,14 +1020,13 @@ def axvspan(self, xmin, xmax, ymin=0, ymax=1, **kwargs):
 
         Returns
         -------
-        rectangle : matplotlib.patches.Polygon
+        rectangle : `~matplotlib.patches.Polygon`
             Vertical span (rectangle) from (xmin, ymin) to (xmax, ymax).
 
         Other Parameters
         ----------------
         **kwargs
-            Optional parameters are properties of the class
-            matplotlib.patches.Polygon.
+            Optional parameters are properties of the class `.Polygon`.
 
         See Also
         --------
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -445,11 +445,11 @@ class _ThetaShift(mtransforms.ScaledTranslation):
 
     Parameters
     ----------
-    axes : matplotlib.axes.Axes
+    axes : `~matplotlib.axes.Axes`
         The owning axes; used to determine limits.
     pad : float
         The padding to apply, in points.
-    start : str, {'min', 'max', 'rlabel'}
+    mode : {'min', 'max', 'rlabel'}
         Whether to shift away from the start (``'min'``) or the end (``'max'``)
         of the axes, or using the rlabel position (``'rlabel'``).
     """
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -1630,14 +1630,14 @@ def set_transform(self, t):
 
         Parameters
         ----------
-        t : matplotlib.transforms.Transform
+        t : `~matplotlib.transforms.Transform`
         """
         Text.set_transform(self, t)
         self.dashline.set_transform(t)
         self.stale = True
 
     def get_figure(self):
-        'return the figure instance the artist belongs to'
+        """Return the figure instance the artist belongs to."""
         return self.figure
 
     def set_figure(self, fig):
@@ -1646,7 +1646,7 @@ def set_figure(self, fig):
 
         Parameters
         ----------
-        fig : matplotlib.figure.Figure
+        fig : `~matplotlib.figure.Figure`
         """
         Text.set_figure(self, fig)
         self.dashline.set_figure(fig)
diff --git a/lib/matplotlib/tri/triinterpolate.py b/lib/matplotlib/tri/triinterpolate.py
@@ -1309,28 +1309,28 @@ def _cg(A, b, x0=None, tol=1.e-10, maxiter=1000):
 
     Parameters
     ----------
-    A: _Sparse_Matrix_coo
+    A : _Sparse_Matrix_coo
         *A* must have been compressed before by compress_csc or
         compress_csr method.
 
-    b: array
+    b : array
         Right hand side of the linear system.
 
     Returns
     -------
-    x: array.
+    x : array
         The converged solution.
-    err: float
+    err : float
         The absolute error np.linalg.norm(A.dot(x) - b)
 
     Other parameters
     ----------------
-    x0: array.
+    x0 : array
         Starting guess for the solution.
-    tol: float.
+    tol : float
         Tolerance to achieve. The algorithm terminates when the relative
         residual is below tol.
-    maxiter: integer.
+    maxiter : integer
         Maximum number of iterations. Iteration will stop
         after maxiter steps even if the specified tolerance has not
         been achieved.
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -155,9 +155,8 @@ def __init__(self, ax, label, image=None,
         """
         Parameters
         ----------
-        ax : matplotlib.axes.Axes
-            The :class:`matplotlib.axes.Axes` instance the button
-            will be placed into.
+        ax : `~matplotlib.axes.Axes`
+            The `~.axes.Axes` instance the button will be placed into.
 
         label : str
             The button text. Accepts string.
@@ -168,10 +167,10 @@ def __init__(self, ax, label, image=None,
             matplotlib Image instance, or Pillow Image).
 
         color : color
-            The color of the button when not activated
+            The color of the button when not activated.
 
         hovercolor : color
-            The color of the button when the mouse is over it
+            The color of the button when the mouse is over it.
         """
         AxesWidget.__init__(self, ax)
 
@@ -692,24 +691,23 @@ def __init__(self, ax, label, initial='',
         """
         Parameters
         ----------
-        ax : matplotlib.axes.Axes
-            The :class:`matplotlib.axes.Axes` instance the button
-            will be placed into.
+        ax : `~matplotlib.axes.Axes`
+            The `~.axes.Axes` instance the button will be placed into.
 
         label : str
             Label for this text box. Accepts string.
 
         initial : str
-            Initial value in the text box
+            Initial value in the text box.
 
         color : color
-            The color of the box
+            The color of the box.
 
         hovercolor : color
-            The color of the box when the mouse is over it
+            The color of the box when the mouse is over it.
 
         label_pad : float
-            the distance between the label and the right side of the textbox
+            The distance between the label and the right side of the textbox.
         """
         AxesWidget.__init__(self, ax)
 
