Browse files

Merge pull request #1082 from efiring/doc_pcolormesh

doc: in pcolormesh docstring, say what it does.
  • Loading branch information...
2 parents 402e06d + 52c0b1d commit 267b0cfe90b412947983f12b44990c326c6ed768 @efiring efiring committed Aug 13, 2012
Showing with 10 additions and 0 deletions.
  1. +10 −0 lib/matplotlib/
@@ -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

0 comments on commit 267b0cf

Please sign in to comment.