Fix broken references.

anntzer · anntzer · commit bc18ac4eaa84 · 2020-01-25T15:41:14.000+01:00
In particular, the property table for artists was changed to point links
to the parent method which actually provides the docstring, if the
docstring is inherited.
diff --git a/doc/api/axis_api.rst b/doc/api/axis_api.rst
@@ -146,7 +146,7 @@ Interactive
    :template: autosummary.rst
    :nosignatures:
 
-
+   Axis.contains
    Axis.get_pickradius
    Axis.set_pickradius
 
diff --git a/doc/users/prev_whats_new/whats_new_1.5.rst b/doc/users/prev_whats_new/whats_new_1.5.rst
@@ -509,12 +509,12 @@ which allow artist-level control of LaTeX rendering vs. the internal mathtex
 rendering.
 
 
-`.Axes.remove()` works as expected
-``````````````````````````````````
+``Axes.remove()`` works as expected
+```````````````````````````````````
 
 As with artists added to an :class:`~matplotlib.axes.Axes`,
 `~.axes.Axes` objects can be removed from their figure via
-:meth:`~matplotlib.axes.Axes.remove()`.
+`~.Artist.remove()`.
 
 
 API Consistency fix within Locators set_params() function
diff --git a/examples/pyplots/align_ylabels.py b/examples/pyplots/align_ylabels.py
@@ -55,7 +55,7 @@ def make_plot(axs):
 #
 #
 # Or we can manually align the axis labels between subplots manually using the
-# `~.YAxis.set_label_coords` method of the y-axis object.  Note this requires
+# `~.Axis.set_label_coords` method of the y-axis object.  Note this requires
 # we know a good offset value which is hardcoded.
 
 fig, axs = plt.subplots(2, 2)
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -393,8 +393,8 @@ def _default_contains(self, mouseevent, figure=None):
                 return inside, info
             # subclass-specific implementation follows
 
-        The `canvas` kwarg is provided for the implementation of
-        `Figure.contains`.
+        The *canvas* kwarg is provided for the implementation of
+        `.Figure.contains`.
         """
         if callable(self._contains):
             return self._contains(self, mouseevent)
@@ -1293,24 +1293,6 @@ def get_valid_values(self, attr):
 
         return 'unknown'
 
-    def _get_setters_and_targets(self):
-        """
-        Get the attribute strings and a full path to where the setter
-        is defined for all setters in an object.
-        """
-        setters = []
-        for name in dir(self.o):
-            if not name.startswith('set_'):
-                continue
-            func = getattr(self.o, name)
-            if (not callable(func)
-                    or len(inspect.signature(func).parameters) < 2
-                    or self.is_alias(func)):
-                continue
-            setters.append(
-                (name[4:], f"{func.__module__}.{func.__qualname__}"))
-        return setters
-
     def _replace_path(self, source_class):
         """
         Changes the full path to the public API path that is used
@@ -1327,7 +1309,17 @@ def get_setters(self):
         Get the attribute strings with setters for object.  e.g., for a line,
         return ``['markerfacecolor', 'linewidth', ....]``.
         """
-        return [prop for prop, target in self._get_setters_and_targets()]
+        setters = []
+        for name in dir(self.o):
+            if not name.startswith('set_'):
+                continue
+            func = getattr(self.o, name)
+            if (not callable(func)
+                    or len(inspect.signature(func).parameters) < 2
+                    or self.is_alias(func)):
+                continue
+            setters.append(name[4:])
+        return setters
 
     def is_alias(self, o):
         """Return whether method object *o* is an alias for another method."""
@@ -1376,24 +1368,20 @@ def pprint_setters(self, prop=None, leadingspace=2):
             accepts = self.get_valid_values(prop)
             return '%s%s: %s' % (pad, prop, accepts)
 
-        attrs = self._get_setters_and_targets()
-        attrs.sort()
         lines = []
-
-        for prop, path in attrs:
+        for prop in sorted(self.get_setters()):
             accepts = self.get_valid_values(prop)
             name = self.aliased_name(prop)
-
             lines.append('%s%s: %s' % (pad, name, accepts))
         return lines
 
     def pprint_setters_rest(self, prop=None, leadingspace=4):
         """
-        If *prop* is *None*, return a list of strings of all settable
-        properties and their valid values.  Format the output for ReST
+        If *prop* is *None*, return a list of ReST-formatted strings of all
+        settable properties and their valid values.
 
         If *prop* is not *None*, it is a valid property name and that
-        property will be returned as a string of property : valid
+        property will be returned as a string of "property : valid"
         values.
         """
         if leadingspace:
@@ -1404,13 +1392,24 @@ def pprint_setters_rest(self, prop=None, leadingspace=4):
             accepts = self.get_valid_values(prop)
             return '%s%s: %s' % (pad, prop, accepts)
 
-        attrs = sorted(self._get_setters_and_targets())
-
-        names = [self.aliased_name_rest(prop, target).replace(
-            '_base._AxesBase', 'Axes').replace(
-            '_axes.Axes', 'Axes')
-                 for prop, target in attrs]
-        accepts = [self.get_valid_values(prop) for prop, target in attrs]
+        prop_and_qualnames = []
+        for prop in sorted(self.get_setters()):
+            # Find the parent method which actually provides the docstring.
+            for cls in self.o.__mro__:
+                method = getattr(cls, f"set_{prop}", None)
+                if method and method.__doc__ is not None:
+                    break
+            else:  # No docstring available.
+                method = getattr(self.o, f"set_{prop}")
+            prop_and_qualnames.append(
+                (prop, f"{method.__module__}.{method.__qualname__}"))
+
+        names = [self.aliased_name_rest(prop, target)
+                 .replace('_base._AxesBase', 'Axes')
+                 .replace('_axes.Axes', 'Axes')
+                 for prop, target in prop_and_qualnames]
+        accepts = [self.get_valid_values(prop)
+                   for prop, _ in prop_and_qualnames]
 
         col0_len = max(len(n) for n in names)
         col1_len = max(len(a) for a in accepts)
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -568,13 +568,7 @@ def _init_axis(self):
         self._update_transScale()
 
     def set_figure(self, fig):
-        """
-        Set the `.Figure` for this `.Axes`.
-
-        Parameters
-        ----------
-        fig : `.Figure`
-        """
+        # docstring inherited
         martist.Artist.set_figure(self, fig)
 
         self.bbox = mtransforms.TransformedBbox(self._position,
@@ -2813,7 +2807,7 @@ def grid(self, b=None, which='major', axis='both', **kwargs):
         grid is determined by the zorder of each axis, not by the zorder of the
         `.Line2D` objects comprising the grid.  Therefore, to set grid zorder,
         use `.set_axisbelow` or, for more control, call the
-        `~matplotlib.axis.Axis.set_zorder` method of each axis.
+        `~.Artist.set_zorder` method of each axis.
         """
         if len(kwargs):
             b = True
diff --git a/tutorials/introductory/lifecycle.py b/tutorials/introductory/lifecycle.py
@@ -157,8 +157,7 @@
 
 ###############################################################################
 # Next, we'll add labels to the plot. To do this with the OO interface,
-# we can use the :meth:`axes.Axes.set` method to set properties of this
-# Axes object.
+# we can use the `.Artist.set` method to set properties of this Axes object.
 
 fig, ax = plt.subplots()
 ax.barh(group_names, group_data)

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ def make_plot(axs):`
`55`	`55`	`#`
`56`	`56`	`#`
`57`	`57`	`# Or we can manually align the axis labels between subplots manually using the`
`58`		-# `~.YAxis.set_label_coords` method of the y-axis object. Note this requires
	`58`	+# `~.Axis.set_label_coords` method of the y-axis object. Note this requires
`59`	`59`	`# we know a good offset value which is hardcoded.`
`60`	`60`
`61`	`61`	`fig, axs = plt.subplots(2, 2)`