No backquotes when doc'ing parameter types.

anntzer · anntzer · commit dcceac40fef6 · 2017-09-08T02:13:32.000-07:00
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -200,13 +200,13 @@ def setup(self, fig, outfile, dpi=None):
 
         Parameters
         ----------
-        fig: `matplotlib.figure.Figure` instance
-            The figure object that contains the information for frames
+        fig: matplotlib.figure.Figure
+            The figure object that contains the information for frames.
         outfile: string
-            The filename of the resulting movie file
+            The filename of the resulting movie file.
         dpi: int, optional
-            The DPI (or resolution) for the file.  This controls the size
-            in pixels of the resulting movie file. Default is ``fig.dpi``.
+            The DPI (or resolution) for the file.  This controls the size in
+            pixels of the resulting movie file.  Default is ``fig.dpi``.
         '''
 
     @abc.abstractmethod
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -353,8 +353,7 @@ def legend(self, *args, **kwargs):
             corner of the legend in axes coordinates (in which case
             ``bbox_to_anchor`` will be ignored).
 
-        bbox_to_anchor : `matplotlib.transforms.BboxBase` instance \
-or tuple of floats
+        bbox_to_anchor : matplotlib.transforms.BboxBase or Tuple[float, ...]
             Specify any arbitrary location for the legend in `bbox_transform`
             coordinates (default Axes coordinates).
 
@@ -2821,11 +2820,11 @@ def errorbar(self, x, y, yerr=None, xerr=None,
 
         Returns
         -------
-        plotline : `~matplotlib.lines.Line2D` instance
+        plotline : matplotlib.lines.Line2D
             x, y plot markers and/or line
-        caplines : list of `~matplotlib.lines.Line2D` instances
+        caplines : List[matplotlib.lines.Line2D]
             error bar cap
-        barlinecols : list of `~matplotlib.collections.LineCollection`
+        barlinecols : List[matplotlib.collections.LineCollection]
             horizontal and vertical error ranges.
 
         Other Parameters
diff --git a/lib/matplotlib/cm.py b/lib/matplotlib/cm.py
@@ -181,12 +181,12 @@ def __init__(self, norm=None, cmap=None):
 
         Parameters
         ----------
-        norm : `matplotlib.colors.Normalize` instance
+        norm : matplotlib.colors.Normalize
             The normalizing object which scales data, typically into the
             interval ``[0, 1]``.
             If *None*, *norm* defaults to a *colors.Normalize* object which
             initializes its scaling based on the first data processed.
-        cmap : str or `~matplotlib.colors.Colormap` instance
+        cmap : str or matplotlib.colors.Colormap
             The colormap used to map normalized data values to RGBA colors.
         """
 
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -1676,25 +1676,23 @@ def shade(self, data, cmap, norm=None, blend_mode='overlay', vmin=None,
         data : array-like
             A 2d array (or equivalent) of the height values used to generate a
             shaded map.
-        cmap : `~matplotlib.colors.Colormap` instance
+        cmap : matplotlib.colors.Colormap
             The colormap used to color the *data* array. Note that this must be
-            a `~matplotlib.colors.Colormap` instance.  For example, rather than
+            a `~matplotlib.colors.Colormap` instance. For example, rather than
             passing in `cmap='gist_earth'`, use
-            `cmap=plt.get_cmap('gist_earth')` instead.
-        norm : `~matplotlib.colors.Normalize` instance, optional
+            ``cmap=plt.get_cmap('gist_earth')`` instead.
+        norm : matplotlib.colors.Normalize, optional
             The normalization used to scale values before colormapping. If
             None, the input will be linearly scaled between its min and max.
         blend_mode : {'hsv', 'overlay', 'soft'} or callable, optional
-            The type of blending used to combine the colormapped data
-            values with the illumination intensity.  Default is
-            "overlay".  Note that for most topographic surfaces,
-            "overlay" or "soft" appear more visually realistic. If a
-            user-defined function is supplied, it is expected to
-            combine an MxNx3 RGB array of floats (ranging 0 to 1) with
-            an MxNx1 hillshade array (also 0 to 1).  (Call signature
-            `func(rgb, illum, **kwargs)`) Additional kwargs supplied
-            to this function will be passed on to the *blend_mode*
-            function.
+            The type of blending used to combine the colormapped data values
+            with the illumination intensity. Default is "overlay". Note that
+            for most topographic surfaces, "overlay" or "soft" appear more
+            visually realistic. If a user-defined function is supplied, it is
+            expected to combine an MxNx3 RGB array of floats (ranging 0 to
+            1) with an MxNx1 hillshade array (also 0 to 1).  (Call signature
+            ``func(rgb, illum, **kwargs)``) Additional kwargs supplied to this
+            function will be passed on to the *blend_mode* function.
         vmin : scalar or None, optional
             The minimum value used in colormapping *data*. If *None* the
             minimum value in *data* is used. If *norm* is specified, then this
diff --git a/lib/matplotlib/legend_handler.py b/lib/matplotlib/legend_handler.py
@@ -81,33 +81,31 @@ def update_prop(self, legend_handle, orig_handle, legend):
         legend_handle.set_clip_path(None)
 
     def adjust_drawing_area(self, legend, orig_handle,
-                            xdescent, ydescent, width, height, fontsize,
-                            ):
+                            xdescent, ydescent, width, height, fontsize):
         xdescent = xdescent - self._xpad * fontsize
         ydescent = ydescent - self._ypad * fontsize
         width = width - self._xpad * fontsize
         height = height - self._ypad * fontsize
         return xdescent, ydescent, width, height
 
-    def legend_artist(self, legend, orig_handle,
-                       fontsize, handlebox):
+    def legend_artist(self, legend, orig_handle, fontsize, handlebox):
         """
         Return the artist that this HandlerBase generates for the given
         original artist/handle.
 
         Parameters
         ----------
-        legend : `matplotlib.legend.Legend` instance
+        legend : matplotlib.legend.Legend
             The legend for which these legend artists are being created.
-        orig_handle : `matplotlib.artist.Artist` or similar
+        orig_handle : matplotlib.artist.Artist
             The object for which these legend artists are being created.
-        fontsize : float or int
-            The fontsize in pixels. The artists being created should
-            be scaled according to the given fontsize.
-        handlebox : `matplotlib.offsetbox.OffsetBox` instance
+        fontsize : float
+            The fontsize in pixels. The artists being created should be scaled
+            according to the given fontsize.
+        handlebox : matplotlib.offsetbox.OffsetBox
             The box which has been created to hold this legend entry's
-            artists. Artists created in the `legend_artist` method must
-            be added to this handlebox inside this method.
+            artists. Artists created in the `legend_artist` method must be
+            added to this handlebox inside this method.
 
         """
         xdescent, ydescent, width, height = self.adjust_drawing_area(
diff --git a/lib/matplotlib/patheffects.py b/lib/matplotlib/patheffects.py
@@ -90,9 +90,9 @@ def __init__(self, path_effects, renderer):
         """
         Parameters
         ----------
-        path_effects : iterable of `AbstractPathEffect`
+        path_effects : Iterable[AbstractPathEffect]
             The path effects which this renderer represents.
-        renderer : `matplotlib.backend_bases.RendererBase` instance
+        renderer : matplotlib.backend_bases.RendererBase
 
         """
         self._path_effects = path_effects
