Merge pull request #16839 from timhoffm/small-doc

timhoffm · web-flow · commit 8badcecab3e9 · 2020-03-19T20:18:13.000+01:00
spines doc cleanup
diff --git a/lib/matplotlib/spines.py b/lib/matplotlib/spines.py
@@ -10,23 +10,19 @@
 
 class Spine(mpatches.Patch):
     """
-    An axis spine -- the line noting the data area boundaries
+    An axis spine -- the line noting the data area boundaries.
 
     Spines are the lines connecting the axis tick marks and noting the
     boundaries of the data area. They can be placed at arbitrary
-    positions. See function:`~matplotlib.spines.Spine.set_position`
-    for more information.
+    positions. See `~.Spine.set_position` for more information.
 
     The default position is ``('outward', 0)``.
 
-    Spines are subclasses of class:`~matplotlib.patches.Patch`, and
-    inherit much of their behavior.
+    Spines are subclasses of `.Patch`, and inherit much of their behavior.
 
     Spines draw a line, a circle, or an arc depending if
-    function:`~matplotlib.spines.Spine.set_patch_line`,
-    function:`~matplotlib.spines.Spine.set_patch_circle`, or
-    function:`~matplotlib.spines.Spine.set_patch_arc` has been called.
-    Line-like is the default.
+    `~.Spine.set_patch_line`, `~.Spine.set_patch_circle`, or
+    `~.Spine.set_patch_arc` has been called. Line-like is the default.
 
     """
     def __str__(self):
@@ -223,7 +219,8 @@ def _ensure_position_is_set(self):
             self.set_position(self._position)
 
     def register_axis(self, axis):
-        """Register an axis.
+        """
+        Register an axis.
 
         An axis should be registered with its corresponding spine from
         the Axes instance. This allows the spine to clear any axis
@@ -486,9 +483,7 @@ def get_bounds(self):
 
     @classmethod
     def linear_spine(cls, axes, spine_type, **kwargs):
-        """
-        Returns a linear `Spine`.
-        """
+        """Create and return a linear `Spine`."""
         # all values of 0.999 get replaced upon call to set_bounds()
         if spine_type == 'left':
             path = mpath.Path([(0.0, 0.999), (0.0, 0.999)])
@@ -508,19 +503,15 @@ def linear_spine(cls, axes, spine_type, **kwargs):
     @classmethod
     def arc_spine(cls, axes, spine_type, center, radius, theta1, theta2,
                   **kwargs):
-        """
-        Returns an arc `Spine`.
-        """
+        """Create and return an arc `Spine`."""
         path = mpath.Path.arc(theta1, theta2)
         result = cls(axes, spine_type, path, **kwargs)
         result.set_patch_arc(center, radius, theta1, theta2)
         return result
 
     @classmethod
     def circular_spine(cls, axes, center, radius, **kwargs):
-        """
-        Returns a circular `Spine`.
-        """
+        """Create and return a circular `Spine`."""
         path = mpath.Path.unit_circle()
         spine_type = 'circle'
         result = cls(axes, spine_type, path, **kwargs)
diff --git a/lib/matplotlib/transforms.py b/lib/matplotlib/transforms.py
@@ -1618,7 +1618,7 @@ class TransformWrapper(Transform):
 
     def __init__(self, child):
         """
-        *child*: A class:`Transform` instance.  This child may later
+        *child*: A `Transform` instance.  This child may later
         be replaced with :meth:`set`.
         """
         cbook._check_isinstance(Transform, child=child)
