Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

doc: in pcolormesh docstring, say what it does.

  • Loading branch information...
commit 52c0b1d0c63ec9634ba507e1bd0a9a54afd2da57 1 parent 5154655
@efiring authored
Showing with 10 additions and 0 deletions.
  1. +10 −0 lib/matplotlib/axes.py
View
10 lib/matplotlib/axes.py
@@ -7221,6 +7221,16 @@ def pcolormesh(self, *args, **kwargs):
pcolormesh(X, Y, C)
pcolormesh(C, **kwargs)
+ Create a pseudocolor plot of a 2-D array.
+
+ pcolormesh is similar to :func:`~matplotlib.pyplot.pcolor`,
+ but uses a different mechanism and returns a different
+ object; pcolor returns a
+ :class:`~matplotlib.collections.PolyCollection` but pcolormesh
+ returns a
+ :class:`~matplotlib.collections.QuadMesh`. It is much faster,
+ so it is almost always preferred for large arrays.
+
*C* may be a masked array, but *X* and *Y* may not. Masked
array support is implemented via *cmap* and *norm*; in
contrast, :func:`~matplotlib.pyplot.pcolor` simply does not
Please sign in to comment.
Something went wrong with that request. Please try again.