Shorten docstrings by removing unneeded :class:/:func: + rewordings.

Author: anntzer

lib/matplotlib/axes/_axes.py

@@ -96,17 +96,14 @@ def inset_locator(ax, renderer):
 
 class Axes(_AxesBase):
     """
-    The :class:`Axes` contains most of the figure elements:
-    :class:`~matplotlib.axis.Axis`, :class:`~matplotlib.axis.Tick`,
-    :class:`~matplotlib.lines.Line2D`, :class:`~matplotlib.text.Text`,
-    :class:`~matplotlib.patches.Polygon`, etc., and sets the
-    coordinate system.
-
-    The :class:`Axes` instance supports callbacks through a callbacks
-    attribute which is a :class:`~matplotlib.cbook.CallbackRegistry`
-    instance.  The events you can connect to are 'xlim_changed' and
-    'ylim_changed' and the callback will be called with func(*ax*)
-    where *ax* is the :class:`Axes` instance.
+    The `Axes` contains most of the figure elements: `~.axis.Axis`,
+    `~.axis.Tick`, `~.lines.Line2D`, `~.text.Text`, `~.patches.Polygon`, etc.,
+    and sets the coordinate system.
+
+    The `Axes` instance supports callbacks through a callbacks attribute which
+    is a `~.cbook.CallbackRegistry` instance.  The events you can connect to
+    are 'xlim_changed' and 'ylim_changed' and the callback will be called with
+    func(*ax*) where *ax* is the `Axes` instance.
 
     Attributes
     ----------
@@ -5967,10 +5964,9 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
 
         .. note::
 
-           ``pcolormesh()`` is similar to :func:`~Axes.pcolor`. It's much
-           faster and preferred in most cases. For a detailed discussion on
-           the differences see
-           :ref:`Differences between pcolor() and pcolormesh()
+           `~Axes.pcolormesh` is similar to `~Axes.pcolor`. It's much faster
+           and preferred in most cases. For a detailed discussion on the
+           differences see :ref:`Differences between pcolor() and pcolormesh()
            <differences-pcolor-pcolormesh>`.
 
         Parameters
@@ -7951,34 +7947,23 @@ def violinplot(self, dataset, positions=None, vert=True, widths=0.5,
           list of the corresponding collection instances created. The
           dictionary has the following keys:
 
-            - ``bodies``: A list of the
-              :class:`matplotlib.collections.PolyCollection` instances
-              containing the filled area of each violin.
+          - ``bodies``: A list of the `~.collections.PolyCollection`
+            instances containing the filled area of each violin.
 
-            - ``cmeans``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the mean values of each of the
-              violin's distribution.
+          - ``cmeans``: A `~.collections.LineCollection` instance that marks
+            the mean values of each of the violin's distribution.
 
-            - ``cmins``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the bottom of each violin's
-              distribution.
+          - ``cmins``: A `~.collections.LineCollection` instance that marks
+            the bottom of each violin's distribution.
 
-            - ``cmaxes``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the top of each violin's
-              distribution.
+          - ``cmaxes``: A `~.collections.LineCollection` instance that marks
+            the top of each violin's distribution.
 
-            - ``cbars``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the centers of each violin's
-              distribution.
+          - ``cbars``: A `~.collections.LineCollection` instance that marks
+            the centers of each violin's distribution.
 
-            - ``cmedians``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the median values of each of the
-              violin's distribution.
+          - ``cmedians``: A `~.collections.LineCollection` instance that
+            marks the median values of each of the violin's distribution.
 
         Notes
         -----
@@ -8057,35 +8042,23 @@ def violin(self, vpstats, positions=None, vert=True, widths=0.5,
           list of the corresponding collection instances created. The
           dictionary has the following keys:
 
-            - ``bodies``: A list of the
-              :class:`matplotlib.collections.PolyCollection` instances
-              containing the filled area of each violin.
-
-            - ``cmeans``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the mean values of each of the
-              violin's distribution.
+          - ``bodies``: A list of the `~.collections.PolyCollection`
+            instances containing the filled area of each violin.
 
-            - ``cmins``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the bottom of each violin's
-              distribution.
+          - ``cmeans``: A `~.collections.LineCollection` instance that marks
+            the mean values of each of the violin's distribution.
 
-            - ``cmaxes``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the top of each violin's
-              distribution.
+          - ``cmins``: A `~.collections.LineCollection` instance that marks
+            the bottom of each violin's distribution.
 
-            - ``cbars``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the centers of each violin's
-              distribution.
+          - ``cmaxes``: A `~.collections.LineCollection` instance that marks
+            the top of each violin's distribution.
 
-            - ``cmedians``: A
-              :class:`matplotlib.collections.LineCollection` instance
-              created to identify the median values of each of the
-              violin's distribution.
+          - ``cbars``: A `~.collections.LineCollection` instance that marks
+            the centers of each violin's distribution.
 
+          - ``cmedians``: A `~.collections.LineCollection` instance that
+            marks the median values of each of the violin's distribution.
         """
 
         # Statistical quantities to be plotted on the violins

lib/matplotlib/patches.py

@@ -193,16 +193,12 @@ def update_from(self, other):
 
     def get_extents(self):
         """
-        Return a :class:`~matplotlib.transforms.Bbox` object defining
-        the axis-aligned extents of the :class:`Patch`.
+        Return the `Patch`'s axis-aligned extents as a `~.transforms.Bbox`.
         """
         return self.get_path().get_extents(self.get_transform())
 
     def get_transform(self):
-        """
-        Return the :class:`~matplotlib.transforms.Transform` applied
-        to the :class:`Patch`.
-        """
+        """Return the `~.transforms.Transform` applied to the `Patch`."""
         return self.get_patch_transform() + artist.Artist.get_transform(self)
 
     def get_data_transform(self):
@@ -977,8 +973,7 @@ def get_path(self):
         Returns
         -------
         path : Path
-           The :class:`~matplotlib.path.Path` object for
-           the polygon
+           The `~.path.Path` object for the polygon.
         """
         return self._path
 
@@ -1168,8 +1163,7 @@ def __init__(self, x, y, dx, dy, width=1.0, **kwargs):
             Scale factor for the width of the arrow. With a default value of
             1, the tail width is 0.2 and head width is 0.6.
         **kwargs
-            Keyword arguments control the :class:`~matplotlib.patches.Patch`
-            properties:
+            Keyword arguments control the `Patch` properties:
 
             %(Patch)s
 

lib/matplotlib/spines.py

@@ -536,7 +536,7 @@ def get_bounds(self):
     @classmethod
     def linear_spine(cls, axes, spine_type, **kwargs):
         """
-        (staticmethod) Returns a linear :class:`Spine`.
+        Returns a linear `Spine`.
         """
         # all values of 0.999 get replaced upon call to set_bounds()
         if spine_type == 'left':
@@ -558,7 +558,7 @@ def linear_spine(cls, axes, spine_type, **kwargs):
     def arc_spine(cls, axes, spine_type, center, radius, theta1, theta2,
                   **kwargs):
         """
-        (classmethod) Returns an arc :class:`Spine`.
+        Returns an arc `Spine`.
         """
         path = mpath.Path.arc(theta1, theta2)
         result = cls(axes, spine_type, path, **kwargs)
@@ -568,7 +568,7 @@ def arc_spine(cls, axes, spine_type, center, radius, theta1, theta2,
     @classmethod
     def circular_spine(cls, axes, center, radius, **kwargs):
         """
-        (staticmethod) Returns a circular :class:`Spine`.
+        Returns a circular `Spine`.
         """
         path = mpath.Path.unit_circle()
         spine_type = 'circle'