Merge pull request #15348 from timhoffm/doc-savefig

jklymak · web-flow · commit 2c1d1c9f19da · 2019-10-01T10:04:44.000-07:00
Some figure and related docs cleanup
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2004,8 +2004,8 @@ def print_figure(self, filename, dpi=None, facecolor=None, edgecolor=None,
         orientation : {'landscape', 'portrait'}, optional
             only currently applies to PostScript printing.
 
-        dpi : scalar, optional
-            the dots per inch to save the figure in; if None, use savefig.dpi
+        dpi : float, default: :rc:`savefig.dpi`
+            The dots per inch to save the figure in.
 
         facecolor : color or None, optional
             the facecolor of the figure; if None, defaults to savefig.facecolor
diff --git a/lib/matplotlib/backends/backend_agg.py b/lib/matplotlib/backends/backend_agg.py
@@ -561,20 +561,18 @@ def print_jpg(self, filename_or_obj, *args, dryrun=False,
 
             Other Parameters
             ----------------
-            quality : int
-                The image quality, on a scale from 1 (worst) to 100 (best).
-                The default is :rc:`savefig.jpeg_quality`.  Values above
-                95 should be avoided; 100 completely disables the JPEG
-                quantization stage.
-
-            optimize : bool
-                If present, indicates that the encoder should
-                make an extra pass over the image in order to select
-                optimal encoder settings.
-
-            progressive : bool
-                If present, indicates that this image
-                should be stored as a progressive JPEG file.
+            quality : int, default: :rc:`savefig.jpeg_quality`
+                The image quality, on a scale from 1 (worst) to 95 (best).
+                Values above 95 should be avoided; 100 disables portions of
+                the JPEG compression algorithm, and results in large files
+                with hardly any gain in image quality.
+
+            optimize : bool, default: False
+                Whether the encoder should make an extra pass over the image
+                in order to select optimal encoder settings.
+
+            progressive : bool, default: False
+                Whether the image should be stored as a progressive JPEG file.
 
             pil_kwargs : dict, optional
                 Additional keyword arguments that are passed to
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1130,7 +1130,7 @@ def add_axes(self, *args, **kwargs):
             a custom projection, see `~matplotlib.projections`. The default
             None results in a 'rectilinear' projection.
 
-        polar : boolean, optional
+        polar : bool, default: False
             If True, equivalent to projection='polar'.
 
         sharex, sharey : `~.axes.Axes`, optional
@@ -1280,7 +1280,7 @@ def add_subplot(self, *args, **kwargs):
             name of a custom projection, see `~matplotlib.projections`. The
             default None results in a 'rectilinear' projection.
 
-        polar : boolean, optional
+        polar : bool, default: False
             If True, equivalent to projection='polar'.
 
         sharex, sharey : `~.axes.Axes`, optional
@@ -2068,7 +2068,7 @@ def savefig(self, fname, *, transparent=None, **kwargs):
                   transparent=False, bbox_inches=None, pad_inches=0.1,
                   frameon=None, metadata=None)
 
-        The output formats available depend on the backend being used.
+        The available output formats depend on the backend being used.
 
         Parameters
         ----------
@@ -2086,27 +2086,28 @@ def savefig(self, fname, *, transparent=None, **kwargs):
 
         Other Parameters
         ----------------
-        dpi : [ *None* | scalar > 0 | 'figure' ]
-            The resolution in dots per inch.  If *None*, defaults to
-            :rc:`savefig.dpi`.  If 'figure', uses the figure's dpi value.
+        dpi : float or 'figure', default: :rc:`savefig.dpi`
+            The resolution in dots per inch.  If 'figure', use the figure's
+            dpi value.
+
+        quality : int, default: :rc:`savefig.jpeg_quality`
+            Applicable only if *format* is 'jpg' or 'jpeg', ignored otherwise.
 
-        quality : [ *None* | 1 <= scalar <= 100 ]
             The image quality, on a scale from 1 (worst) to 95 (best).
-            Applicable only if *format* is jpg or jpeg, ignored otherwise.
-            If *None*, defaults to :rc:`savefig.jpeg_quality`.
-            Values above 95 should be avoided; 100 completely disables the
-            JPEG quantization stage.
-
-        optimize : bool
-            If *True*, indicates that the JPEG encoder should make an extra
-            pass over the image in order to select optimal encoder settings.
-            Applicable only if *format* is jpg or jpeg, ignored otherwise.
-            Is *False* by default.
-
-        progressive : bool
-            If *True*, indicates that this image should be stored as a
-            progressive JPEG file. Applicable only if *format* is jpg or
-            jpeg, ignored otherwise. Is *False* by default.
+            Values above 95 should be avoided; 100 disables portions of
+            the JPEG compression algorithm, and results in large files
+            with hardly any gain in image quality.
+
+        optimize : bool, default: False
+            Applicable only if *format* is 'jpg' or 'jpeg', ignored otherwise.
+
+            Whether the encoder should make an extra pass over the image
+            in order to select optimal encoder settings.
+
+        progressive : bool, default: False
+            Applicable only if *format* is 'jpg' or 'jpeg', ignored otherwise.
+
+            Whether the image should be stored as a progressive JPEG file.
 
         facecolor : color or None, optional
             The facecolor of the figure; if *None*, defaults to
@@ -2331,11 +2332,9 @@ def waitforbuttonpress(self, timeout=-1):
         """
         Blocking call to interact with the figure.
 
-        This will return True is a key was pressed, False if a mouse
-        button was pressed and None if *timeout* was reached without
-        either being pressed.
-
-        If *timeout* is negative, does not timeout.
+        Wait for user input and return True if a key was pressed, False if a
+        mouse button was pressed and None if no input was given within
+        *timeout* seconds.  Negative values deactivate *timeout*.
         """
         blocking_input = BlockingKeyMouseInput(self)
         return blocking_input(timeout=timeout)
@@ -2450,7 +2449,7 @@ def tight_layout(self, renderer=None, pad=1.08, h_pad=None, w_pad=None,
 
         To exclude an artist on the axes from the bounding box calculation
         that determines the subplot parameters (i.e. legend, or annotation),
-        then set `a.set_in_layout(False)` for that artist.
+        set `a.set_in_layout(False)` for that artist.
 
         Parameters
         ----------
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -732,7 +732,7 @@ def axes(arg=None, **kwargs):
         a custom projection, see `~matplotlib.projections`. The default
         None results in a 'rectilinear' projection.
 
-    polar : boolean, optional
+    polar : bool, default: False
         If True, equivalent to projection='polar'.
 
     sharex, sharey : `~.axes.Axes`, optional
@@ -857,7 +857,7 @@ def subplot(*args, **kwargs):
         of a custom projection, see `~matplotlib.projections`. The default
         None results in a 'rectilinear' projection.
 
-    polar : boolean, optional
+    polar : bool, default: False
         If True, equivalent to projection='polar'.
 
     sharex, sharey : `~.axes.Axes`, optional
