Cleanup docstring of print_figure, savefig.

anntzer · anntzer · commit 99eb7a410647 · 2020-01-21T01:30:34.000+01:00
Correct doc for filename.  Move doc for orientation down to its position
in the signature.  Make typespec for bbox_inches fit in one line (I
think the line continuation is ugly enough to prefer not using a fully
qualified name for .Bbox).
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1974,11 +1974,8 @@ def print_figure(self, filename, dpi=None, facecolor=None, edgecolor=None,
 
         Parameters
         ----------
-        filename
-            can also be a file object on image backends
-
-        orientation : {'landscape', 'portrait'}, default: 'portrait'
-            only currently applies to PostScript printing.
+        filename : str or path-like or file-like
+            The file where the figure is saved.
 
         dpi : float, default: :rc:`savefig.dpi`
             The dots per inch to save the figure in.
@@ -1989,16 +1986,17 @@ def print_figure(self, filename, dpi=None, facecolor=None, edgecolor=None,
         edgecolor : color, default: :rc:`savefig.edgecolor`
             The edgecolor of the figure.
 
+        orientation : {'landscape', 'portrait'}, default: 'portrait'
+            Only currently applies to PostScript printing.
+
         format : str, optional
             Force a specific file format. If not given, the format is inferred
             from the *filename* extension, and if that fails from
             :rc:`savefig.format`.
 
-        bbox_inches : 'tight' or `~matplotlib.transforms.Bbox`, \
-default: :rc:`savefig.bbox`
-            Bbox in inches. Only the given portion of the figure is
-            saved. If 'tight', try to figure out the tight bbox of
-            the figure.
+        bbox_inches : 'tight' or `.Bbox`, default: :rc:`savefig.bbox`
+            Bounding box in inches: only the given portion of the figure is
+            saved.  If 'tight', try to figure out the tight bbox of the figure.
 
         pad_inches : float, default: :rc:`savefig.pad_inches`
             Amount of padding around the figure when *bbox_inches* is 'tight'.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2112,10 +2112,9 @@ def savefig(self, fname, *, transparent=None, **kwargs):
             transparency of these patches will be restored to their
             original values upon exit of this function.
 
-        bbox_inches : str or `~matplotlib.transforms.Bbox`, optional
-            Bbox in inches. Only the given portion of the figure is
-            saved. If 'tight', try to figure out the tight bbox of
-            the figure. If None, use savefig.bbox
+        bbox_inches : str or `.Bbox`, default: :rc:`savefig.bbox`
+            Bounding box in inches: only the given portion of the figure is
+            saved.  If 'tight', try to figure out the tight bbox of the figure.
 
         pad_inches : scalar, optional
             Amount of padding around the figure when bbox_inches is
