Merge pull request matplotlib#26214 from tacaswell/auto-backport-of-pr-26186-on-v3.7.x

Auto backport of pr 26186 on v3.7.x

Author: QuLogic

lib/matplotlib/artist.py

@@ -490,7 +490,7 @@ def contains(self, mouseevent):
 
         Parameters
         ----------
-        mouseevent : `matplotlib.backend_bases.MouseEvent`
+        mouseevent : `~matplotlib.backend_bases.MouseEvent`
 
         Returns
         -------
@@ -781,7 +781,7 @@ def set_clip_path(self, path, transform=None):
 
         Parameters
         ----------
-        path : `.Patch` or `.Path` or `.TransformedPath` or None
+        path : `~matplotlib.patches.Patch` or `.Path` or `.TransformedPath` or None
             The clip path. If given a `.Path`, *transform* must be provided as
             well. If *None*, a previously set clip path is removed.
         transform : `~matplotlib.transforms.Transform`, optional
@@ -1307,7 +1307,7 @@ def get_cursor_data(self, event):
 
         Parameters
         ----------
-        event : `matplotlib.backend_bases.MouseEvent`
+        event : `~matplotlib.backend_bases.MouseEvent`
 
         See Also
         --------
@@ -1721,7 +1721,7 @@ def getp(obj, property=None):
 
     Parameters
     ----------
-    obj : `.Artist`
+    obj : `~matplotlib.artist.Artist`
         The queried artist; e.g., a `.Line2D`, a `.Text`, or an `~.axes.Axes`.
 
     property : str or None, default: None
@@ -1760,7 +1760,7 @@ def setp(obj, *args, file=None, **kwargs):
 
     Parameters
     ----------
-    obj : `.Artist` or list of `.Artist`
+    obj : `~matplotlib.artist.Artist` or list of `.Artist`
         The artist(s) whose properties are being set or queried.  When setting
         properties, all artists are affected; when querying the allowed values,
         only the first instance in the sequence is queried.

lib/matplotlib/axes/_axes.py

@@ -143,7 +143,7 @@ def set_title(self, label, fontdict=None, loc=None, pad=None, *, y=None,
 
         Other Parameters
         ----------------
-        **kwargs : `.Text` properties
+        **kwargs : `~matplotlib.text.Text` properties
             Other keyword arguments are text properties, see `.Text` for a list
             of valid text properties.
         """
@@ -1574,7 +1574,7 @@ def plot(self, *args, scalex=True, scaley=True, data=None, **kwargs):
             data limits. The values are passed on to
             `~.axes.Axes.autoscale_view`.
 
-        **kwargs : `.Line2D` properties, optional
+        **kwargs : `~matplotlib.lines.Line2D` properties, optional
             *kwargs* are used to specify properties like a line label (for
             auto legends), linewidth, antialiasing, marker face color.
             Example::
@@ -1966,13 +1966,13 @@ def acorr(self, x, **kwargs):
 
             - `.LineCollection` if *usevlines* is True.
             - `.Line2D` if *usevlines* is False.
-        b : `.Line2D` or None
+        b : `~matplotlib.lines.Line2D` or None
             Horizontal line at 0 if *usevlines* is True
             None *usevlines* is False.
 
         Other Parameters
         ----------------
-        linestyle : `.Line2D` property, optional
+        linestyle : `~matplotlib.lines.Line2D` property, optional
             The linestyle for plotting the data points.
             Only used if *usevlines* is ``False``.
 
@@ -2043,13 +2043,13 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
 
             - `.LineCollection` if *usevlines* is True.
             - `.Line2D` if *usevlines* is False.
-        b : `.Line2D` or None
+        b : `~matplotlib.lines.Line2D` or None
             Horizontal line at 0 if *usevlines* is True
             None *usevlines* is False.
 
         Other Parameters
         ----------------
-        linestyle : `.Line2D` property, optional
+        linestyle : `~matplotlib.lines.Line2D` property, optional
             The linestyle for plotting the data points.
             Only used if *usevlines* is ``False``.
 
@@ -3425,8 +3425,10 @@ def errorbar(self, x, y, yerr=None, xerr=None,
         `.ErrorbarContainer`
             The container contains:
 
-            - plotline: `.Line2D` instance of x, y plot markers and/or line.
-            - caplines: A tuple of `.Line2D` instances of the error bar caps.
+            - plotline: `~matplotlib.lines.Line2D` instance of x, y plot markers
+              and/or line.
+            - caplines: A tuple of `~matplotlib.lines.Line2D` instances of the error
+              bar caps.
             - barlinecols: A tuple of `.LineCollection` with the horizontal and
               vertical error ranges.
 
@@ -6984,7 +6986,7 @@ def stairs(self, values, edges=None, *,
 
         Returns
         -------
-        StepPatch : `matplotlib.patches.StepPatch`
+        StepPatch : `~matplotlib.patches.StepPatch`
 
         Other Parameters
         ----------------

lib/matplotlib/axes/_base.py

@@ -604,7 +604,7 @@ def __init__(self, fig,
             being created.  Finally, ``*args`` can also directly be a
             `.SubplotSpec` instance.
 
-        sharex, sharey : `~.axes.Axes`, optional
+        sharex, sharey : `~matplotlib.axes.Axes`, optional
             The x- or y-`~.matplotlib.axis` is shared with the x- or y-axis in
             the input `~.axes.Axes`.
 
@@ -3172,7 +3172,7 @@ def grid(self, visible=None, which='major', axis='both', **kwargs):
         axis : {'both', 'x', 'y'}, optional
             The axis to apply the changes on.
 
-        **kwargs : `.Line2D` properties
+        **kwargs : `~matplotlib.lines.Line2D` properties
             Define the line properties of the grid, e.g.::
 
                 grid(color='r', linestyle='-', linewidth=2)
@@ -3438,7 +3438,7 @@ def set_xlabel(self, xlabel, fontdict=None, labelpad=None, *,
 
         Other Parameters
         ----------------
-        **kwargs : `.Text` properties
+        **kwargs : `~matplotlib.text.Text` properties
             `.Text` properties control the appearance of the label.
 
         See Also
@@ -3687,7 +3687,7 @@ def set_ylabel(self, ylabel, fontdict=None, labelpad=None, *,
 
         Other Parameters
         ----------------
-        **kwargs : `.Text` properties
+        **kwargs : `~matplotlib.text.Text` properties
             `.Text` properties control the appearance of the label.
 
         See Also

lib/matplotlib/axis.py

@@ -43,15 +43,15 @@ class Tick(martist.Artist):
 
     Attributes
     ----------
-    tick1line : `.Line2D`
+    tick1line : `~matplotlib.lines.Line2D`
         The left/bottom tick marker.
-    tick2line : `.Line2D`
+    tick2line : `~matplotlib.lines.Line2D`
         The right/top tick marker.
-    gridline : `.Line2D`
+    gridline : `~matplotlib.lines.Line2D`
         The grid line associated with the label position.
-    label1 : `.Text`
+    label1 : `~matplotlib.text.Text`
         The left/bottom tick label.
-    label2 : `.Text`
+    label2 : `~matplotlib.text.Text`
         The right/top tick label.
 
     """
@@ -534,9 +534,9 @@ class Ticker:
 
     Attributes
     ----------
-    locator : `matplotlib.ticker.Locator` subclass
+    locator : `~matplotlib.ticker.Locator` subclass
         Determines the positions of the ticks.
-    formatter : `matplotlib.ticker.Formatter` subclass
+    formatter : `~matplotlib.ticker.Formatter` subclass
         Determines the format of the tick labels.
     """
 
@@ -609,20 +609,20 @@ class Axis(martist.Artist):
     ----------
     isDefault_label : bool
 
-    axes : `matplotlib.axes.Axes`
+    axes : `~matplotlib.axes.Axes`
         The `~.axes.Axes` to which the Axis belongs.
-    major : `matplotlib.axis.Ticker`
+    major : `~matplotlib.axis.Ticker`
         Determines the major tick positions and their label format.
-    minor : `matplotlib.axis.Ticker`
+    minor : `~matplotlib.axis.Ticker`
         Determines the minor tick positions and their label format.
-    callbacks : `matplotlib.cbook.CallbackRegistry`
+    callbacks : `~matplotlib.cbook.CallbackRegistry`
 
-    label : `.Text`
+    label : `~matplotlib.text.Text`
         The axis label.
     labelpad : float
         The distance between the axis label and the tick labels.
         Defaults to :rc:`axes.labelpad` = 4.
-    offsetText : `.Text`
+    offsetText : `~matplotlib.text.Text`
         A `.Text` object containing the data offset of the ticks (if any).
     pickradius : float
         The acceptance radius for containment tests. See also `.Axis.contains`.
@@ -645,7 +645,7 @@ def __init__(self, axes, pickradius=15):
         """
         Parameters
         ----------
-        axes : `matplotlib.axes.Axes`
+        axes : `~matplotlib.axes.Axes`
             The `~.axes.Axes` to which the created Axis belongs.
         pickradius : float
             The acceptance radius for containment tests. See also
@@ -1634,7 +1634,7 @@ def grid(self, visible=None, which='major', **kwargs):
         which : {'major', 'minor', 'both'}
             The grid lines to apply the changes on.
 
-        **kwargs : `.Line2D` properties
+        **kwargs : `~matplotlib.lines.Line2D` properties
             Define the line properties of the grid, e.g.::
 
                 grid(color='r', linestyle='-', linewidth=2)

lib/matplotlib/backend_bases.py

@@ -207,9 +207,9 @@ def draw_markers(self, gc, marker_path, marker_trans, path,
         ----------
         gc : `.GraphicsContextBase`
             The graphics context.
-        marker_trans : `matplotlib.transforms.Transform`
+        marker_trans : `~matplotlib.transforms.Transform`
             An affine transform applied to the marker.
-        trans : `matplotlib.transforms.Transform`
+        trans : `~matplotlib.transforms.Transform`
             An affine transform applied to the path.
         """
         for vertices, codes in path.iter_segments(trans, simplify=False):
@@ -299,7 +299,7 @@ def draw_gouraud_triangle(self, gc, points, colors, transform):
             Array of (x, y) points for the triangle.
         colors : (3, 4) array-like
             RGBA colors for each point of the triangle.
-        transform : `matplotlib.transforms.Transform`
+        transform : `~matplotlib.transforms.Transform`
             An affine transform to apply to the points.
         """
         raise NotImplementedError
@@ -317,7 +317,7 @@ def draw_gouraud_triangles(self, gc, triangles_array, colors_array,
             Array of *N* (x, y) points for the triangles.
         colors_array : (N, 3, 4) array-like
             Array of *N* RGBA colors for each point of the triangles.
-        transform : `matplotlib.transforms.Transform`
+        transform : `~matplotlib.transforms.Transform`
             An affine transform to apply to the points.
         """
         raise NotImplementedError
@@ -521,7 +521,7 @@ def draw_tex(self, gc, x, y, s, prop, angle, *, mtext=None):
             The font properties.
         angle : float
             The rotation angle in degrees anti-clockwise.
-        mtext : `matplotlib.text.Text`
+        mtext : `~matplotlib.text.Text`
             The original text object to be rendered.
         """
         self._draw_text_as_path(gc, x, y, s, prop, angle, ismath="TeX")
@@ -546,7 +546,7 @@ def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
             The rotation angle in degrees anti-clockwise.
         ismath : bool or "TeX"
             If True, use mathtext parser. If "TeX", use tex for rendering.
-        mtext : `matplotlib.text.Text`
+        mtext : `~matplotlib.text.Text`
             The original text object to be rendered.
 
         Notes
@@ -1325,7 +1325,7 @@ class LocationEvent(Event):
     ----------
     x, y : int or None
         Event location in pixels from bottom left of canvas.
-    inaxes : `~.axes.Axes` or None
+    inaxes : `~matplotlib.axes.Axes` or None
         The `~.axes.Axes` instance over which the mouse is, if any.
     xdata, ydata : float or None
         Data coordinates of the mouse within *inaxes*, or *None* if the mouse
@@ -1465,7 +1465,7 @@ class PickEvent(Event):
     ----------
     mouseevent : `MouseEvent`
         The mouse event that generated the pick.
-    artist : `matplotlib.artist.Artist`
+    artist : `~matplotlib.artist.Artist`
         The picked artist.  Note that artists are not pickable by default
         (see `.Artist.set_picker`).
     other
@@ -1630,7 +1630,7 @@ class FigureCanvasBase:
 
     Attributes
     ----------
-    figure : `matplotlib.figure.Figure`
+    figure : `~matplotlib.figure.Figure`
         A high-level figure instance.
     """
 

lib/matplotlib/backends/backend_mixed.py

@@ -19,19 +19,19 @@ def __init__(self, figure, width, height, dpi, vector_renderer,
         """
         Parameters
         ----------
-        figure : `matplotlib.figure.Figure`
+        figure : `~matplotlib.figure.Figure`
             The figure instance.
         width : scalar
             The width of the canvas in logical units
         height : scalar
             The height of the canvas in logical units
         dpi : float
             The dpi of the canvas
-        vector_renderer : `matplotlib.backend_bases.RendererBase`
+        vector_renderer : `~matplotlib.backend_bases.RendererBase`
             An instance of a subclass of
             `~matplotlib.backend_bases.RendererBase` that will be used for the
             vector drawing.
-        raster_renderer_class : `matplotlib.backend_bases.RendererBase`
+        raster_renderer_class : `~matplotlib.backend_bases.RendererBase`
             The renderer class to use for the raster drawing.  If not provided,
             this will use the Agg backend (which is currently the only viable
             option anyway.)

lib/matplotlib/backends/backend_pgf.py

@@ -395,7 +395,7 @@ def __init__(self, figure, fh):
 
         Attributes
         ----------
-        figure : `matplotlib.figure.Figure`
+        figure : `~matplotlib.figure.Figure`
             Matplotlib figure to initialize height, width and dpi from.
         fh : file-like
             File handle for the output of the drawing commands.

lib/matplotlib/backends/backend_template.py

@@ -159,7 +159,7 @@ class methods button_press_event, button_release_event,
 
     Attributes
     ----------
-    figure : `matplotlib.figure.Figure`
+    figure : `~matplotlib.figure.Figure`
         A high-level Figure instance
     """
 

lib/matplotlib/cm.py

@@ -270,7 +270,7 @@ def _get_cmap(name=None, lut=None):
 
     Parameters
     ----------
-    name : `matplotlib.colors.Colormap` or str or None, default: None
+    name : `~matplotlib.colors.Colormap` or str or None, default: None
         If a `.Colormap` instance, it will be returned. Otherwise, the name of
         a colormap known to Matplotlib, which will be resampled by *lut*. The
         default, None, means :rc:`image.cmap`.

lib/matplotlib/colorbar.py

@@ -1394,13 +1394,13 @@ def make_axes(parents, location=None, orientation=None, fraction=0.15,
 
     Parameters
     ----------
-    parents : `~.axes.Axes` or iterable or `numpy.ndarray` of `~.axes.Axes`
+    parents : `~matplotlib.axes.Axes` or iterable or `numpy.ndarray` of `~.axes.Axes`
         The Axes to use as parents for placing the colorbar.
     %(_make_axes_kw_doc)s
 
     Returns
     -------
-    cax : `~.axes.Axes`
+    cax : `~matplotlib.axes.Axes`
         The child axes.
     kwargs : dict
         The reduced keyword dictionary to be passed when creating the colorbar
@@ -1508,13 +1508,13 @@ def make_axes_gridspec(parent, *, location=None, orientation=None,
 
     Parameters
     ----------
-    parent : `~.axes.Axes`
+    parent : `~matplotlib.axes.Axes`
         The Axes to use as parent for placing the colorbar.
     %(_make_axes_kw_doc)s
 
     Returns
     -------
-    cax : `~.axes.Axes`
+    cax : `~matplotlib.axes.Axes`
         The child axes.
     kwargs : dict
         The reduced keyword dictionary to be passed when creating the colorbar