Merge pull request matplotlib#19132 from timhoffm/kwdoc-interpolate

MNT: Normalize docstring interpolation label for kwdoc() property lists

Author: tacaswell

lib/matplotlib/artist.py

@@ -1701,4 +1701,4 @@ def kwdoc(artist):
             'Properties:\n' + '\n'.join(ai.pprint_setters(leadingspace=4)))
 
 
-docstring.interpd.update(Artist=kwdoc(Artist))
+docstring.interpd.update(Artist_kwdoc=kwdoc(Artist))

lib/matplotlib/axes/_axes.py

@@ -396,7 +396,7 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
         **kwargs
             Other keyword arguments are passed on to the `.Rectangle` patch:
 
-            %(Rectangle)s
+            %(Rectangle_kwdoc)s
 
         Returns
         -------
@@ -685,7 +685,7 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
             Valid keyword arguments are `.Line2D` properties, with the
             exception of 'transform':
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -752,7 +752,7 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
             Valid keyword arguments are `.Line2D` properties, with the
             exception of 'transform':
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -836,7 +836,7 @@ def axline(self, xy1, xy2=None, *, slope=None, **kwargs):
         **kwargs
             Valid kwargs are `.Line2D` properties
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -904,7 +904,7 @@ def axhspan(self, ymin, ymax, xmin=0, xmax=1, **kwargs):
         ----------------
         **kwargs : `~matplotlib.patches.Polygon` properties
 
-        %(Polygon)s
+        %(Polygon_kwdoc)s
 
         See Also
         --------
@@ -951,7 +951,7 @@ def axvspan(self, xmin, xmax, ymin=0, ymax=1, **kwargs):
         ----------------
         **kwargs : `~matplotlib.patches.Polygon` properties
 
-        %(Polygon)s
+        %(Polygon_kwdoc)s
 
         See Also
         --------
@@ -1502,7 +1502,7 @@ def plot(self, *args, scalex=True, scaley=True, data=None, **kwargs):
 
             Here is a list of available `.Line2D` properties:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -1643,7 +1643,7 @@ def plot_date(self, x, y, fmt='o', tz=None, xdate=True, ydate=False,
         **kwargs
             Keyword arguments control the `.Line2D` properties:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -2214,7 +2214,7 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
 
         **kwargs : `.Rectangle` properties
 
-        %(Rectangle)s
+        %(Rectangle_kwdoc)s
 
         See Also
         --------
@@ -2483,7 +2483,7 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
 
         **kwargs : `.Rectangle` properties
 
-        %(Rectangle)s
+        %(Rectangle_kwdoc)s
 
         See Also
         --------
@@ -2544,7 +2544,7 @@ def broken_barh(self, xranges, yrange, **kwargs):
 
             Supported keywords:
 
-            %(BrokenBarHCollection)s
+            %(BrokenBarHCollection_kwdoc)s
         """
         # process the unit information
         if len(xranges):
@@ -3133,7 +3133,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
 
             Valid kwargs for the marker properties are `.Line2D` properties:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
         """
         kwargs = cbook.normalize_kwargs(kwargs, mlines.Line2D)
         # anything that comes in as 'None', drop so the default thing
@@ -4556,7 +4556,7 @@ def reduce_C_function(C: array) -> float
         **kwargs : `~matplotlib.collections.PolyCollection` properties
             All other keyword arguments are passed on to `.PolyCollection`:
 
-            %(PolyCollection)s
+            %(PolyCollection_kwdoc)s
 
         """
         self._process_unit_info([("x", x), ("y", y)], kwargs, convert=False)
@@ -5072,7 +5072,7 @@ def _fill_between_x_or_y(
             All other keyword arguments are passed on to `.PolyCollection`.
             They control the `.Polygon` properties:
 
-            %(PolyCollection)s
+            %(PolyCollection_kwdoc)s
 
         See Also
         --------
@@ -5677,7 +5677,7 @@ def pcolor(self, *args, shading=None, alpha=None, norm=None, cmap=None,
             Additionally, the following arguments are allowed. They are passed
             along to the `~matplotlib.collections.PolyCollection` constructor:
 
-        %(PolyCollection)s
+        %(PolyCollection_kwdoc)s
 
         See Also
         --------
@@ -5922,7 +5922,7 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
             Additionally, the following arguments are allowed. They are passed
             along to the `~matplotlib.collections.QuadMesh` constructor:
 
-        %(QuadMesh)s
+        %(QuadMesh_kwdoc)s
 
         See Also
         --------
@@ -6963,7 +6963,7 @@ def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
         **kwargs
             Keyword arguments control the `.Line2D` properties:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -7076,7 +7076,7 @@ def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
         **kwargs
             Keyword arguments control the `.Line2D` properties:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -7166,7 +7166,7 @@ def magnitude_spectrum(self, x, Fs=None, Fc=None, window=None,
         **kwargs
             Keyword arguments control the `.Line2D` properties:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -7243,7 +7243,7 @@ def angle_spectrum(self, x, Fs=None, Fc=None, window=None,
         **kwargs
             Keyword arguments control the `.Line2D` properties:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -7309,7 +7309,7 @@ def phase_spectrum(self, x, Fs=None, Fc=None, window=None,
         **kwargs
             Keyword arguments control the `.Line2D` properties:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         See Also
         --------
@@ -7376,7 +7376,7 @@ def cohere(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
         **kwargs
             Keyword arguments control the `.Line2D` properties:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         References
         ----------
@@ -7626,7 +7626,7 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
             For the marker style, you can pass any `.Line2D` property except
             for *linestyle*:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
         """
         if marker is None and markersize is None and hasattr(Z, 'tocoo'):
             marker = 's'

lib/matplotlib/axes/_base.py

@@ -503,7 +503,7 @@ def __init__(self, fig, rect,
         **kwargs
             Other optional keyword arguments:
 
-            %(Axes)s
+            %(Axes_kwdoc)s
 
         Returns
         -------
@@ -2955,7 +2955,7 @@ def grid(self, b=None, which='major', axis='both', **kwargs):
 
             Valid keyword arguments are:
 
-            %(_Line2D_docstr)s
+            %(Line2D_kwdoc)s
 
         Notes
         -----

lib/matplotlib/axes/_subplots.py

@@ -210,7 +210,7 @@ class when called with an axes class. This is purely to allow pickling of
     return subplot_class.__new__(subplot_class)
 
 
-docstring.interpd.update(Axes=martist.kwdoc(Axes))
+docstring.interpd.update(Axes_kwdoc=martist.kwdoc(Axes))
 docstring.dedent_interpd(Axes.__init__)
 
-docstring.interpd.update(Subplot=martist.kwdoc(Axes))
+docstring.interpd.update(Subplot_kwdoc=martist.kwdoc(Axes))

lib/matplotlib/collections.py

@@ -2082,10 +2082,10 @@ def draw(self, renderer):
         self.stale = False
 
 
-patchstr = artist.kwdoc(Collection)
+_artist_kwdoc = artist.kwdoc(Collection)
 for k in ('QuadMesh', 'TriMesh', 'PolyCollection', 'BrokenBarHCollection',
           'RegularPolyCollection', 'PathCollection',
           'StarPolygonCollection', 'PatchCollection',
           'CircleCollection', 'Collection',):
-    docstring.interpd.update({k: patchstr})
-docstring.interpd.update(LineCollection=artist.kwdoc(LineCollection))
+    docstring.interpd.update({f'{k}_kwdoc': _artist_kwdoc})
+docstring.interpd.update(LineCollection_kwdoc=artist.kwdoc(LineCollection))

lib/matplotlib/figure.py

@@ -637,7 +637,7 @@ def add_axes(self, *args, **kwargs):
             arguments if another projection is used, see the actual Axes
             class.
 
-            %(Axes)s
+            %(Axes_kwdoc)s
 
         Notes
         -----
@@ -798,7 +798,7 @@ def add_subplot(self, *args, **kwargs):
             the following table but there might also be other keyword
             arguments if another projection is used.
 
-            %(Axes)s
+            %(Axes_kwdoc)s
 
         Notes
         -----
@@ -1599,7 +1599,7 @@ def gca(self, **kwargs):
         adheres to the given projection etc., and for Axes creation if
         the active Axes does not exist:
 
-        %(Axes)s
+        %(Axes_kwdoc)s
 
         """
         ckey, cax = self._axstack.current_key_axes()
@@ -3342,4 +3342,5 @@ def figaspect(arg):
     newsize = np.clip(newsize, figsize_min, figsize_max)
     return newsize
 
-docstring.interpd.update(Figure=martist.kwdoc(Figure))
+
+docstring.interpd.update(Figure_kwdoc=martist.kwdoc(Figure))

lib/matplotlib/lines.py

@@ -300,7 +300,7 @@ def __init__(self, xdata, ydata,
 
         Additional keyword arguments are `.Line2D` properties:
 
-        %(_Line2D_docstr)s
+        %(Line2D_kwdoc)s
 
         See :meth:`set_linestyle` for a description of the line styles,
         :meth:`set_marker` for a description of the markers, and
@@ -1549,7 +1549,7 @@ def onpick(self, event):
 drawStyles = Line2D.drawStyles
 fillStyles = MarkerStyle.fillstyles
 
-docstring.interpd.update(_Line2D_docstr=artist.kwdoc(Line2D))
+docstring.interpd.update(Line2D_kwdoc=artist.kwdoc(Line2D))
 
 # You can not set the docstring of an instancemethod,
 # but you can on the underlying function.  Go figure.