pcolormesh help not helpful #703

Closed
kaufman opened this Issue Feb 11, 2012 · 4 comments

Projects

None yet

4 participants

@kaufman

The help for this function doesn't really describe what the function is supposed to do.

pcolormesh(args, *kwargs)
call signatures::

  pcolormesh(C)
  pcolormesh(X, Y, C)
  pcolormesh(C, **kwargs)

*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
draw quadrilaterals with masked colors or vertices.

Keyword arguments:
@pelson
Matplotlib Developers member

I agree completely.

There is a guide on how to contribute to the documentation (http://matplotlib.sourceforge.net/faq/howto_faq.html#contribute-to-matplotlib-documentation), but if you don't feel comfortable submitting a patch then please update this issue with the text you would like to see and I would be happy to make a pull request for you.

@kaufman
@WeatherGod WeatherGod was assigned Feb 22, 2012
@WeatherGod
Matplotlib Developers member

I have noted this and will be updating the docstring at some point.

@efiring
Matplotlib Developers member

closed by #1082

@efiring efiring closed this Aug 13, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment