Merge pull request #19293 from QuLogic/fix-doc-interpolations

anntzer · web-flow · commit 79b6e22b0682 · 2021-01-18T22:11:05.000+01:00
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -673,7 +673,7 @@ this example from `matplotlib.lines`:
 .. code-block:: python
 
   # in lines.py
-  docstring.interpd.update(Line2D=artist.kwdoc(Line2D))
+  docstring.interpd.update(Line2D_kwdoc=artist.kwdoc(Line2D))
 
 Then in any function accepting `~.Line2D` pass-through ``kwargs``, e.g.,
 `matplotlib.axes.Axes.plot`:
@@ -686,13 +686,28 @@ Then in any function accepting `~.Line2D` pass-through ``kwargs``, e.g.,
       """
       Some stuff omitted
 
-      The kwargs are Line2D properties:
-      %(_Line2D_docstr)s
+      Other Parameters
+      ----------------
+      scalex, scaley : bool, default: True
+          These parameters determine if the view limits are adapted to the
+          data limits. The values are passed on to `autoscale_view`.
+
+      **kwargs : `.Line2D` properties, optional
+          *kwargs* are used to specify properties like a line label (for
+          auto legends), linewidth, antialiasing, marker face color.
+          Example::
+
+          >>> plot([1, 2, 3], [1, 2, 3], 'go-', label='line 1', linewidth=2)
+          >>> plot([1, 2, 3], [1, 4, 9], 'rs', label='line 2')
+
+          If you specify multiple lines with one plot call, the kwargs apply
+          to all those lines. In case the label object is iterable, each
+          element is used as labels for each set of data.
+
+          Here is a list of available `.Line2D` properties:
+
+          %(Line2D_kwdoc)s
 
-      kwargs scalex and scaley, if defined, are passed on
-      to autoscale_view to determine whether the x and y axes are
-      autoscaled; default True.  See Axes.autoscale_view for more
-      information
       """
 
 Note there is a problem for `~matplotlib.artist.Artist` ``__init__`` methods,
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -352,6 +352,7 @@ def inset_axes(self, bounds, *, transform=None, zorder=5, **kwargs):
 
         return inset_ax
 
+    @docstring.dedent_interpd
     def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
                        facecolor='none', edgecolor='0.5', alpha=0.5,
                        zorder=4.99, **kwargs):
@@ -921,6 +922,7 @@ def axhspan(self, ymin, ymax, xmin=0, xmax=1, **kwargs):
         self._request_autoscale_view(scalex=False)
         return p
 
+    @docstring.dedent_interpd
     def axvspan(self, xmin, xmax, ymin=0, ymax=1, **kwargs):
         """
         Add a vertical span (rectangle) across the Axes.
@@ -1497,10 +1499,9 @@ def plot(self, *args, scalex=True, scaley=True, data=None, **kwargs):
             >>> plot([1, 2, 3], [1, 2, 3], 'go-', label='line 1', linewidth=2)
             >>> plot([1, 2, 3], [1, 4, 9], 'rs', label='line 2')
 
-            If you make multiple lines with one plot call, the kwargs
-            apply to all those lines.
-            In case if label object is iterable, each its element is
-            used as label for a separate line.
+            If you specify multiple lines with one plot call, the kwargs apply
+            to all those lines. In case the label object is iterable, each
+            element is used as labels for each set of data.
 
             Here is a list of available `.Line2D` properties:
 
