add documentation for quality in savefig (#11529)

pharshalp · tacaswell · commit 25b736a0e2c8 · 2018-06-28T16:14:51.000-04:00
* add documentation for quality in savefig based on the discussion here #458 and also using some of the lines from https://matplotlib.org/api/backend_agg_api.html?highlight=print_jpeg#matplotlib.backends.backend_agg.FigureCanvasAgg.print_jpeg
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1812,6 +1812,13 @@ def savefig(self, fname, *, frameon=None, transparent=None, **kwargs):
             The resolution in dots per inch.  If *None*, defaults to
             :rc:`savefig.dpi`.  If 'figure', uses the figure's dpi value.
 
+        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` (95 by default).
+            Values above 95 should be avoided; 100 completely disables the
+            JPEG quantization stage.
+
         facecolor : color spec or None, optional
             The facecolor of the figure; if *None*, defaults to
             :rc:`savefig.facecolor`.
