Merge pull request #21964 from anntzer/mr

dstansby · web-flow · commit 7443d8842a0e · 2021-12-15T14:23:28.000Z
Fix some more missing references.
diff --git a/doc/api/prev_api_changes/api_changes_3.0.0.rst b/doc/api/prev_api_changes/api_changes_3.0.0.rst
@@ -197,7 +197,7 @@ Contour color autoscaling improvements
 Selection of contour levels is now the same for contour and
 contourf; previously, for contour, levels outside the data range were
 deleted.  (Exception: if no contour levels are found within the
-data range, the `levels` attribute is replaced with a list holding
+data range, the ``levels`` attribute is replaced with a list holding
 only the minimum of the data range.)
 
 When contour is called with levels specified as a target number rather
diff --git a/doc/api/prev_api_changes/api_changes_3.1.0.rst b/doc/api/prev_api_changes/api_changes_3.1.0.rst
@@ -496,7 +496,7 @@ Classes and methods
 - ``backend_wx.Toolbar`` (use ``backend_wx.NavigationToolbar2Wx`` instead)
 - ``cbook.align_iterators`` (no replacement)
 - ``contour.ContourLabeler.get_real_label_width`` (no replacement)
-- ``legend.Legend.draggable`` (use `legend.Legend.set_draggable()` instead)
+- ``legend.Legend.draggable`` (use `.legend.Legend.set_draggable()` instead)
 - ``texmanager.TexManager.postscriptd``, ``texmanager.TexManager.pscnt``,
   ``texmanager.TexManager.make_ps``, ``texmanager.TexManager.get_ps_bbox``
   (no replacements)
diff --git a/doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst b/doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst
@@ -46,9 +46,9 @@ highest.
 Code that worked around the normalization between 0 and 1 will need to be
 modified.
 
-`MovieWriterRegistry`
-~~~~~~~~~~~~~~~~~~~~~
-`MovieWriterRegistry` now always checks the availability of the writer classes
+``MovieWriterRegistry``
+~~~~~~~~~~~~~~~~~~~~~~~
+`.MovieWriterRegistry` now always checks the availability of the writer classes
 before returning them.  If one wishes, for example, to get the first available
 writer, without performing the availability check on subsequent writers, it is
 now possible to iterate over the registry, which will yield the names of the
diff --git a/doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst b/doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst
@@ -118,7 +118,7 @@ The unused ``Locator.autoscale`` method is deprecated (pass the axis limits to
 
 Animation
 ~~~~~~~~~
-The following methods and attributes of the `MovieWriterRegistry` class are
+The following methods and attributes of the `.MovieWriterRegistry` class are
 deprecated: ``set_dirty``, ``ensure_not_dirty``, ``reset_available_writers``,
 ``avail``.
 
diff --git a/doc/missing-references.json b/doc/missing-references.json
@@ -631,11 +631,6 @@
       "lib/matplotlib/animation.py:docstring of matplotlib.animation.FFMpegBase:4",
       "lib/matplotlib/animation.py:docstring of matplotlib.animation.ImageMagickBase:4"
     ],
-    "MovieWriterRegistry": [
-      "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:49",
-      "doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:51",
-      "doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:121"
-    ],
     "QuadContourSet.changed()": [
       "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes._axes.Axes.contour:133",
       "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes._axes.Axes.contourf:133",
@@ -717,9 +712,6 @@
     "axis.Axis.get_ticks_position": [
       "doc/api/prev_api_changes/api_changes_3.1.0.rst:826"
     ],
-    "backend_bases.RendererBase": [
-      "lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template.RendererTemplate:4"
-    ],
     "backend_bases.ToolContainerBase": [
       "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.add_tools_to_container:8"
     ],
@@ -742,9 +734,6 @@
     "draw_image": [
       "lib/matplotlib/backends/backend_agg.py:docstring of matplotlib.backends.backend_agg.RendererAgg.option_scale_image:2"
     ],
-    "fc-list": [
-      "lib/matplotlib/font_manager.py:docstring of matplotlib.font_manager.get_fontconfig_fonts:2"
-    ],
     "figure.bbox": [
       "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes._axes.Axes.legend:140",
       "lib/matplotlib/figure.py:docstring of matplotlib.figure.FigureBase.legend:141",
@@ -761,9 +750,6 @@
     "fmt_ydata": [
       "lib/matplotlib/axes/_base.py:docstring of matplotlib.axes._base._AxesBase.format_ydata:4"
     ],
-    "gaussian_kde": [
-      "lib/matplotlib/mlab.py:docstring of matplotlib.mlab.GaussianKDE:32"
-    ],
     "get_size": [
       "lib/mpl_toolkits/axes_grid1/axes_size.py:docstring of mpl_toolkits.axes_grid1.axes_size:1"
     ],
@@ -773,9 +759,6 @@
     "get_ybound": [
       "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d:22"
     ],
-    "h_pad": [
-      "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.set_constrained_layout:5"
-    ],
     "image": [
       "lib/matplotlib/sphinxext/plot_directive.py:docstring of matplotlib.sphinxext.plot_directive:79"
     ],
@@ -801,12 +784,6 @@
       "lib/matplotlib/mlab.py:docstring of matplotlib.mlab.GaussianKDE:45",
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.violinplot:46"
     ],
-    "legend.Legend.set_draggable()": [
-      "doc/api/prev_api_changes/api_changes_3.1.0.rst:499"
-    ],
-    "levels": [
-      "doc/api/prev_api_changes/api_changes_3.0.0.rst:197"
-    ],
     "load_char": [
       "doc/gallery/misc/ftface_props.rst:25"
     ],
@@ -1120,9 +1097,6 @@
     "tool_removed_event": [
       "lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase.remove_toolitem:6"
     ],
-    "w_pad": [
-      "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.set_constrained_layout:5"
-    ],
     "whats_new.rst": [
       "doc/users/next_whats_new/README.rst:6"
     ],
diff --git a/lib/matplotlib/backends/backend_template.py b/lib/matplotlib/backends/backend_template.py
@@ -41,7 +41,7 @@ class RendererTemplate(RendererBase):
     The renderer handles drawing/rendering operations.
 
     This is a minimal do-nothing class that can be used to get started when
-    writing a new backend.  Refer to `backend_bases.RendererBase` for
+    writing a new backend.  Refer to `.backend_bases.RendererBase` for
     documentation of the methods.
     """
 
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2444,7 +2444,7 @@ def set_constrained_layout(self, constrained):
         Set whether ``constrained_layout`` is used upon drawing. If None,
         :rc:`figure.constrained_layout.use` value will be used.
 
-        When providing a dict containing the keys `w_pad`, `h_pad`
+        When providing a dict containing the keys ``w_pad``, ``h_pad``
         the default ``constrained_layout`` paddings will be
         overridden.  These pads are in inches and default to 3.0/72.0.
         ``w_pad`` is the width padding and ``h_pad`` is the height padding.
diff --git a/lib/matplotlib/font_manager.py b/lib/matplotlib/font_manager.py
@@ -327,7 +327,7 @@ def _get_win32_installed_fonts():
 
 @lru_cache()
 def _get_fontconfig_fonts():
-    """Cache and list the font paths known to `fc-list`."""
+    """Cache and list the font paths known to ``fc-list``."""
     try:
         if b'--format' not in subprocess.check_output(['fc-list', '--help']):
             _log.warning(  # fontconfig 2.7 implemented --format.
@@ -341,7 +341,7 @@ def _get_fontconfig_fonts():
 
 @_api.deprecated("3.5")
 def get_fontconfig_fonts(fontext='ttf'):
-    """List font filenames known to `fc-list` having the given extension."""
+    """List font filenames known to ``fc-list`` having the given extension."""
     fontext = ['.' + ext for ext in get_fontext_synonyms(fontext)]
     return [str(path) for path in _get_fontconfig_fonts()
             if path.suffix.lower() in fontext]
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -851,7 +851,6 @@ class GaussianKDE:
     dataset : array-like
         Datapoints to estimate from. In case of univariate data this is a 1-D
         array, otherwise a 2D array with shape (# of dims, # of data).
-
     bw_method : str, scalar or callable, optional
         The method used to calculate the estimator bandwidth.  This can be
         'scott', 'silverman', a scalar constant or a callable.  If a
@@ -862,33 +861,26 @@ class GaussianKDE:
     Attributes
     ----------
     dataset : ndarray
-        The dataset with which `gaussian_kde` was initialized.
-
+        The dataset passed to the constructor.
     dim : int
         Number of dimensions.
-
     num_dp : int
         Number of datapoints.
-
     factor : float
         The bandwidth factor, obtained from `kde.covariance_factor`, with which
         the covariance matrix is multiplied.
-
     covariance : ndarray
         The covariance matrix of *dataset*, scaled by the calculated bandwidth
         (`kde.factor`).
-
     inv_cov : ndarray
         The inverse of *covariance*.
 
     Methods
     -------
     kde.evaluate(points) : ndarray
         Evaluate the estimated pdf on a provided set of points.
-
     kde(points) : ndarray
         Same as kde.evaluate(points)
-
     """
 
     # This implementation with minor modification was too good to pass up.
