Merge pull request #26480 from oscargus/docfixes3

tacaswell · web-flow · commit f800bf61cd86 · 2023-08-09T09:11:27.000-04:00
[DOC] Documentation fixes
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -3540,8 +3540,8 @@ def get_xlim(self):
         See Also
         --------
         .Axes.set_xlim
-        set_xbound, get_xbound
-        invert_xaxis, xaxis_inverted
+        .Axes.set_xbound, .Axes.get_xbound
+        .Axes.invert_xaxis, .Axes.xaxis_inverted
 
         Notes
         -----
@@ -3788,8 +3788,8 @@ def get_ylim(self):
         See Also
         --------
         .Axes.set_ylim
-        set_ybound, get_ybound
-        invert_yaxis, yaxis_inverted
+        .Axes.set_ybound, .Axes.get_ybound
+        .Axes.invert_yaxis, .Axes.yaxis_inverted
 
         Notes
         -----
diff --git a/lib/matplotlib/transforms.py b/lib/matplotlib/transforms.py
@@ -1825,7 +1825,7 @@ class Affine2DBase(AffineBase):
     affine transformation, use `Affine2D`.
 
     Subclasses of this class will generally only need to override a
-    constructor and :meth:`get_matrix` that generates a custom 3x3 matrix.
+    constructor and `~.Transform.get_matrix` that generates a custom 3x3 matrix.
     """
     input_dims = 2
     output_dims = 2
diff --git a/lib/mpl_toolkits/axes_grid1/axes_size.py b/lib/mpl_toolkits/axes_grid1/axes_size.py
@@ -1,5 +1,5 @@
 """
-Provides classes of simple units that will be used with AxesDivider
+Provides classes of simple units that will be used with `.AxesDivider`
 class (or others) to determine the size of each Axes. The unit
 classes define `get_size` method that returns a tuple of two floats,
 meaning relative and absolute sizes, respectively.
@@ -25,8 +25,18 @@ def __add__(self, other):
         else:
             return Add(self, Fixed(other))
 
+    def get_size(self, renderer):
+        """
+        Return two-float tuple with relative and absolute sizes.
+        """
+        raise NotImplementedError("Subclasses must implement")
+
 
 class Add(_Base):
+    """
+    Sum of two sizes.
+    """
+
     def __init__(self, a, b):
         self._a = a
         self._b = b
@@ -198,8 +208,9 @@ def from_any(size, fraction_ref=None):
     Fraction unit if that is a string that ends with %. The second
     argument is only meaningful when Fraction unit is created.
 
-    >>> a = Size.from_any(1.2) # => Size.Fixed(1.2)
-    >>> Size.from_any("50%", a) # => Size.Fraction(0.5, a)
+    >>> from mpl_toolkits.axes_grid1.axes_size import from_any
+    >>> a = from_any(1.2) # => Fixed(1.2)
+    >>> from_any("50%", a) # => Fraction(0.5, a)
     """
     if isinstance(size, Real):
         return Fixed(size)
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -719,7 +719,25 @@ def get_ylim(self):
         return tuple(self.xy_viewLim.intervaly)
 
     def get_zlim(self):
-        """Get 3D z limits."""
+        """
+        Return the 3D z-axis view limits.
+
+        Returns
+        -------
+        left, right : (float, float)
+            The current z-axis limits in data coordinates.
+
+        See Also
+        --------
+        set_zlim
+        set_zbound, get_zbound
+        invert_zaxis, zaxis_inverted
+
+        Notes
+        -----
+        The z-axis may be inverted, in which case the *left* value will
+        be greater than the *right* value.
+        """
         return tuple(self.zz_viewLim.intervalx)
 
     get_zscale = _axis_method_wrapper("zaxis", "get_scale")
@@ -1475,6 +1493,12 @@ def tick_params(self, axis='both', **kwargs):
     def invert_zaxis(self):
         """
         Invert the z-axis.
+
+        See Also
+        --------
+        zaxis_inverted
+        get_zlim, set_zlim
+        get_zbound, set_zbound
         """
         bottom, top = self.get_zlim()
         self.set_zlim(top, bottom, auto=None)
@@ -1484,6 +1508,12 @@ def invert_zaxis(self):
     def get_zbound(self):
         """
         Return the lower and upper z-axis bounds, in increasing order.
+
+        See Also
+        --------
+        set_zbound
+        get_zlim, set_zlim
+        invert_zaxis, zaxis_inverted
         """
         bottom, top = self.get_zlim()
         if bottom < top:
@@ -1497,6 +1527,18 @@ def set_zbound(self, lower=None, upper=None):
 
         This method will honor axes inversion regardless of parameter order.
         It will not change the autoscaling setting (`.get_autoscalez_on()`).
+
+        Parameters
+        ----------
+        lower, upper : float or None
+            The lower and upper bounds. If *None*, the respective axis bound
+            is not modified.
+
+        See Also
+        --------
+        get_zbound
+        get_zlim, set_zlim
+        invert_zaxis, zaxis_inverted
         """
         if upper is None and np.iterable(lower):
             lower, upper = lower
@@ -1513,11 +1555,24 @@ def set_zbound(self, lower=None, upper=None):
 
     def text(self, x, y, z, s, zdir=None, **kwargs):
         """
-        Add text to the plot.
+        Add the text *s* to the 3D Axes at location *x*, *y*, *z* in data coordinates.
 
-        Keyword arguments will be passed on to `.Axes.text`, except for the
-        *zdir* keyword, which sets the direction to be used as the z
-        direction.
+        Parameters
+        ----------
+        x, y, z : float
+            The position to place the text.
+        s : str
+            The text.
+        zdir : {'x', 'y', 'z', 3-tuple}, optional
+            The direction to be used as the z-direction. Default: 'z'.
+            See `.get_dir_vector` for a description of the values.
+        **kwargs
+            Other arguments are forwarded to `matplotlib.axes.Axes.text`.
+
+        Returns
+        -------
+        `.Text3D`
+            The created `.Text3D` instance.
         """
         text = super().text(x, y, s, **kwargs)
         art3d.text_2d_to_3d(text, z, zdir)
