Document rasterized parameter in pcolormesh() explicitly (#18956)

philip-sparks · jklymak · web-flow · commit c486cd7ffa44 · 2020-11-18T23:15:38.000+01:00
* Update _axes.py for #17708 Update _axes.py to include mentions of rasterization within pcolormesh fixes #17708 * Update _axes.py * Update _axes.py * Update _axes.py * Update lib/matplotlib/axes/_axes.py Co-authored-by: Jody Klymak <jklymak@gmail.com> * Update lib/matplotlib/axes/_axes.py Co-authored-by: Jody Klymak <jklymak@gmail.com> * Update _axes.py Co-authored-by: Jody Klymak <jklymak@gmail.com>
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -5834,6 +5834,7 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
            differences see :ref:`Differences between pcolor() and pcolormesh()
            <differences-pcolor-pcolormesh>`.
 
+
         Parameters
         ----------
         C : array-like
@@ -5925,6 +5926,10 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
         snap : bool, default: False
             Whether to snap the mesh to pixel boundaries.
 
+        rasterized: bool, optional
+            Rasterize the pcolormesh before drawing.  Can produce images
+            faster and make smaller files for large data sets.
+
         Returns
         -------
         `matplotlib.collections.QuadMesh`
