8000 docstring: direct pcolor users to pcolormesh; fix pcolorfast docstring by efiring · Pull Request #1353 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

docstring: direct pcolor users to pcolormesh; fix pcolorfast docstring #1353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmcdougall merged 1 commit into from
Oct 10, 2012
Merged

docstring: direct pcolor users to pcolormesh; fix pcolorfast docstring #1353

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions lib/matplotlib/axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7142,6 +7142,10 @@ def pcolor(self, *args, **kwargs):
"""
Create a pseudocolor plot of a 2-D array.

Note: pcolor can be very slow for large arrays; consider
using the similar but much faster
:func:`~matplotlib.pyplot.pcolormesh` instead.

Call signatures::

pcolor(C, **kwargs)
Expand Down Expand Up @@ -7272,6 +7276,11 @@ def pcolor(self, *args, **kwargs):
Stroking the edges may be preferred if *alpha* is 1, but
will cause artifacts otherwise.

.. seealso::

:func:`~matplotlib.pyplot.pcolormesh`
For an explanation of the differences between
pcolor and pcolormesh.
"""

if not self._hold: self.cla()
Expand Down Expand Up @@ -7498,23 +7507,25 @@ def pcolorfast(self, *args, **kwargs):
"""
pseudocolor plot of a 2-D array

Experimental; this is a version of pcolor that
does not draw lines, that provides the fastest
possible rendering with the Agg backend, and that
can handle any quadrilateral grid.
Experimental; this is a pcolor-type method that
provides the fastest possible rendering with the Agg
backend, and that can handle any quadrilateral grid.
It supports only flat shading (no outlines), it lacks
support for log scaling of the axes, and it does not
have a pyplot wrapper.

Call signatures::

pcolor(C, **kwargs)
pcolor(xr, yr, C, **kwargs)
pcolor(x, y, C, **kwargs)
pcolor(X, Y, C, **kwargs)
ax.pcolorfast(C, **kwargs)
ax.pcolorfast(xr, yr, C, **kwargs)
ax.pcolorfast(x, y, C, **kwargs)
ax.pcolorfast(X, Y, C, **kwargs)

C is the 2D array of color values corresponding to quadrilateral
cells. Let (nr, nc) be its shape. C may be a masked array.

``pcolor(C, **kwargs)`` is equivalent to
``pcolor([0,nc], [0,nr], C, **kwargs)``
``ax.pcolorfast(C, **kwargs)`` is equivalent to
``ax.pcolorfast([0,nc], [0,nr], C, **kwargs)``

*xr*, *yr* specify the ranges of *x* and *y* corresponding to the
rectangular region bounding *C*. If::
Expand Down
0