DOC: Turn deprecation alternatives into doc references

where possible

Author: StefRe

lib/matplotlib/axis.py

@@ -211,7 +211,7 @@ def _apply_tickdir(self, tickdir):
         self._tickdir = tickdir
         self._pad = self._base_pad + self.get_tick_padding()
 
-    @_api.deprecated("3.5", alternative="axis.set_tick_params")
+    @_api.deprecated("3.5", alternative="`.Axis.set_tick_params`")
     def apply_tickdir(self, tickdir):
         self._apply_tickdir(tickdir)
         self.stale = True
@@ -822,7 +822,7 @@ def clear(self):
         self.set_units(None)
         self.stale = True
 
-    @_api.deprecated("3.4", alternative="Axis.clear()")
+    @_api.deprecated("3.4", alternative="`.Axis.clear`")
     def cla(self):
         """Clear this axis."""
         return self.clear()

lib/matplotlib/backend_bases.py

@@ -2280,8 +2280,8 @@ def get_default_filetype(cls):
         """
         return rcParams['savefig.format']
 
-    @_api.deprecated(
-        "3.4", alternative="manager.get_window_title or GUI-specific methods")
+    @_api.deprecated("3.4", alternative="`.FigureManagerBase.get_window_title`"
+                     " or GUI-specific methods")
     def get_window_title(self):
         """
         Return the title text of the window containing the figure, or None
@@ -2290,8 +2290,8 @@ def get_window_title(self):
         if self.manager is not None:
             return self.manager.get_window_title()
 
-    @_api.deprecated(
-        "3.4", alternative="manager.set_window_title or GUI-specific methods")
+    @_api.deprecated("3.4", alternative="`.FigureManagerBase.set_window_title`"
+                     " or GUI-specific methods")
     def set_window_title(self, title):
         """
         Set the title text of the window containing the figure.  Note that
@@ -3223,7 +3223,7 @@ def save_figure(self, *args):
         """Save the current figure."""
         raise NotImplementedError
 
-    @_api.deprecated("3.5", alternative="canvas.set_cursor")
+    @_api.deprecated("3.5", alternative="`.FigureCanvasBase.set_cursor`")
     def set_cursor(self, cursor):
         """
         Set the current cursor to one of the :class:`Cursors` enums values.

lib/matplotlib/backend_tools.py

@@ -309,7 +309,7 @@ def _set_cursor_cbk(self, event):
             self.canvas.set_cursor(self._default_cursor)
             self._last_cursor = self._default_cursor
 
-    @_api.deprecated("3.5", alternative="figure.canvas.set_cursor")
+    @_api.deprecated("3.5", alternative="`.FigureCanvasBase.set_cursor`")
     def set_cursor(self, cursor):
         """
         Set the cursor.

lib/matplotlib/collections.py

@@ -2076,7 +2076,8 @@ def get_coordinates(self):
         return self._coordinates
 
     @staticmethod
-    @_api.deprecated("3.5", alternative="QuadMesh(coordinates).get_paths()")
+    @_api.deprecated("3.5", alternative="`QuadMesh(coordinates).get_paths()"
+                     "<.QuadMesh.get_paths>`")
     def convert_mesh_to_paths(meshWidth, meshHeight, coordinates):
         return QuadMesh._convert_mesh_to_paths(coordinates)
 

lib/matplotlib/colorbar.py

@@ -1589,12 +1589,12 @@ def make_axes_gridspec(parent, *, location=None, orientation=None,
     return cax, kwargs
 
 
-@_api.deprecated("3.4", alternative="Colorbar")
+@_api.deprecated("3.4", alternative="`.Colorbar`")
 class ColorbarPatch(Colorbar):
     pass
 
 
-@_api.deprecated("3.4", alternative="Colorbar")
+@_api.deprecated("3.4", alternative="`.Colorbar`")
 def colorbar_factory(cax, mappable, **kwargs):
     """
     Create a colorbar on the given axes for the given mappable.

lib/matplotlib/dates.py

@@ -1681,12 +1681,12 @@ def set_axis(self, axis):
         self._wrapped_locator.set_axis(axis)
         return super().set_axis(axis)
 
-    @_api.deprecated("3.5", alternative=".axis.set_view_interval")
+    @_api.deprecated("3.5", alternative="`.Axis.set_view_interval`")
     def set_view_interval(self, vmin, vmax):
         self._wrapped_locator.set_view_interval(vmin, vmax)
         return super().set_view_interval(vmin, vmax)
 
-    @_api.deprecated("3.5", alternative=".axis.set_data_interval")
+    @_api.deprecated("3.5", alternative="`.Axis.set_data_interval`")
     def set_data_interval(self, vmin, vmax):
         self._wrapped_locator.set_data_interval(vmin, vmax)
         return super().set_data_interval(vmin, vmax)
@@ -1722,8 +1722,8 @@ def _get_interval(self):
         return self._interval
 
 
-@_api.deprecated("3.5",
-                 alternative="mdates.date2num(datetime.utcfromtimestamp(e))")
+@_api.deprecated("3.5", alternative="" +
+                 "`date2num(datetime.utcfromtimestamp(e))<.date2num>`")
 def epoch2num(e):
     """
     Convert UNIX time to days since Matplotlib epoch.
@@ -1745,7 +1745,7 @@ def epoch2num(e):
     return (dt + np.asarray(e)) / SEC_PER_DAY
 
 
-@_api.deprecated("3.5", alternative="mdates.num2date(e).timestamp()")
+@_api.deprecated("3.5", alternative="`num2date(e).timestamp()<.num2date>`")
 def num2epoch(d):
     """
     Convert days since Matplotlib epoch to UNIX time.

lib/matplotlib/mathtext.py

@@ -179,15 +179,15 @@ def get_hinting_type(self):
         return backend_agg.get_hinting_flag()
 
 
-@_api.deprecated("3.4", alternative="mathtext.math_to_image")
+@_api.deprecated("3.4", alternative="`.mathtext.math_to_image`")
 class MathtextBackendBitmap(MathtextBackendAgg):
     def get_results(self, box, used_characters):
         ox, oy, width, height, depth, image, characters = \
             super().get_results(box, used_characters)
         return image, depth
 
 
-@_api.deprecated("3.4", alternative="MathtextBackendPath")
+@_api.deprecated("3.4", alternative="`.MathtextBackendPath`")
 class MathtextBackendPs(MathtextBackend):
     """
     Store information to write a mathtext rendering to the PostScript backend.
@@ -231,7 +231,7 @@ def get_results(self, box, used_characters):
                               used_characters)
 
 
-@_api.deprecated("3.4", alternative="MathtextBackendPath")
+@_api.deprecated("3.4", alternative="`.MathtextBackendPath`")
 class MathtextBackendPdf(MathtextBackend):
     """Store information to write a mathtext rendering to the PDF backend."""
 
@@ -263,7 +263,7 @@ def get_results(self, box, used_characters):
                                used_characters)
 
 
-@_api.deprecated("3.4", alternative="MathtextBackendPath")
+@_api.deprecated("3.4", alternative="`.MathtextBackendPath`")
 class MathtextBackendSvg(MathtextBackend):
     """
     Store information to write a mathtext rendering to the SVG
@@ -324,7 +324,7 @@ def get_results(self, box, used_characters):
                             self.rects)
 
 
-@_api.deprecated("3.4", alternative="MathtextBackendPath")
+@_api.deprecated("3.4", alternative="`.MathtextBackendPath`")
 class MathtextBackendCairo(MathtextBackend):
     """
     Store information to write a mathtext rendering to the Cairo
@@ -457,7 +457,7 @@ def _parse_cached(self, s, dpi, prop, force_standard_ps_fonts):
         font_output.set_canvas_size(box.width, box.height, box.depth)
         return font_output.get_results(box)
 
-    @_api.deprecated("3.4", alternative="mathtext.math_to_image")
+    @_api.deprecated("3.4", alternative="`.mathtext.math_to_image`")
     def to_mask(self, texstr, dpi=120, fontsize=14):
         r"""
         Convert a mathtext string to a grayscale array and depth.
@@ -483,7 +483,7 @@ def to_mask(self, texstr, dpi=120, fontsize=14):
         ftimage, depth = self.parse(texstr, dpi=dpi, prop=prop)
         return np.asarray(ftimage), depth
 
-    @_api.deprecated("3.4", alternative="mathtext.math_to_image")
+    @_api.deprecated("3.4", alternative="`.mathtext.math_to_image`")
     def to_rgba(self, texstr, color='black', dpi=120, fontsize=14):
         r"""
         Convert a mathtext string to an RGBA array and depth.
@@ -512,7 +512,7 @@ def to_rgba(self, texstr, color='black', dpi=120, fontsize=14):
         rgba[:, :, 3] = alpha
         return rgba, depth
 
-    @_api.deprecated("3.4", alternative="mathtext.math_to_image")
+    @_api.deprecated("3.4", alternative="`.mathtext.math_to_image`")
     def to_png(self, filename, texstr, color='black', dpi=120, fontsize=14):
         r"""
         Render a tex expression to a PNG file.
@@ -540,7 +540,7 @@ def to_png(self, filename, texstr, color='black', dpi=120, fontsize=14):
         Image.fromarray(rgba).save(filename, format="png")
         return depth
 
-    @_api.deprecated("3.4", alternative="mathtext.math_to_image")
+    @_api.deprecated("3.4", alternative="`.mathtext.math_to_image`")
     def get_depth(self, texstr, dpi=120, fontsize=14):
         r"""
         Get the depth of a mathtext string.

lib/matplotlib/spines.py

@@ -222,7 +222,7 @@ def clear(self):
         if self.axis is not None:
             self.axis.clear()
 
-    @_api.deprecated("3.4", alternative="Spine.clear()")
+    @_api.deprecated("3.4", alternative="`.Spine.clear`")
     def cla(self):
         self.clear()
 

lib/matplotlib/ticker.py

@@ -187,17 +187,17 @@ def create_dummy_axis(self, **kwargs):
         if self.axis is None:
             self.axis = _DummyAxis(**kwargs)
 
-    @_api.deprecated("3.5", alternative=".axis.set_view_interval")
+    @_api.deprecated("3.5", alternative="`.Axis.set_view_interval`")
     def set_view_interval(self, vmin, vmax):
         self.axis.set_view_interval(vmin, vmax)
 
-    @_api.deprecated("3.5", alternative=".axis.set_data_interval")
+    @_api.deprecated("3.5", alternative="`.Axis.set_data_interval`")
     def set_data_interval(self, vmin, vmax):
         self.axis.set_data_interval(vmin, vmax)
 
     @_api.deprecated(
         "3.5",
-        alternative=".axis.set_view_interval and .axis.set_data_interval")
+        alternative="`.Axis.set_view_interval` and `.Axis.set_data_interval`")
     def set_bounds(self, vmin, vmax):
         self.set_view_interval(vmin, vmax)
         self.set_data_interval(vmin, vmax)