Merge pull request #19140 from anntzer/suplabels-docstring

timhoffm · web-flow · commit d53555b594c5 · 2020-12-17T21:53:45.000+01:00
Fix the docstring of suptitle/subxlabel/supylabel.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -373,38 +373,32 @@ def get_window_extent(self, *args, **kwargs):
 
     def _suplabels(self, t, info, **kwargs):
         """
-        Add a centered {name} to the figure.
+        Add a centered %(name)s to the figure.
 
         Parameters
         ----------
         t : str
-            The {name} text.
-
-        x : float, default: {x0}
+            The %(name)s text.
+        x : float, default: %(x0)s
             The x location of the text in figure coordinates.
-
-        y : float, default: {y0}
+        y : float, default: %(y0)s
             The y location of the text in figure coordinates.
-
-        horizontalalignment, ha : {{'center', 'left', 'right'}}, default: {ha}
+        horizontalalignment, ha : {'center', 'left', 'right'}, default: %(ha)s
             The horizontal alignment of the text relative to (*x*, *y*).
-
-        verticalalignment, va : {{'top', 'center', 'bottom', 'baseline'}}, \
-default: {va}
+        verticalalignment, va : {'top', 'center', 'bottom', 'baseline'}, \
+default: %(va)s
             The vertical alignment of the text relative to (*x*, *y*).
-
         fontsize, size : default: :rc:`figure.titlesize`
             The font size of the text. See `.Text.set_size` for possible
             values.
-
         fontweight, weight : default: :rc:`figure.titleweight`
             The font weight of the text. See `.Text.set_weight` for possible
             values.
 
         Returns
         -------
         text
-            The `.Text` instance of the {name}.
+            The `.Text` instance of the %(name)s.
 
         Other Parameters
         ----------------
@@ -416,7 +410,6 @@ def _suplabels(self, t, info, **kwargs):
 
         **kwargs
             Additional kwargs are `matplotlib.text.Text` properties.
-
         """
 
         manual_position = ('x' in kwargs or 'y' in kwargs)
