From 52c0b1d0c63ec9634ba507e1bd0a9a54afd2da57 Mon Sep 17 00:00:00 2001 From: Eric Firing Date: Mon, 13 Aug 2012 09:05:01 -1000 Subject: [PATCH] doc: in pcolormesh docstring, say what it does. --- lib/matplotlib/axes.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py index 668beec0dbe5..01e772c44647 100644 --- a/lib/matplotlib/axes.py +++ b/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