Improve docstring of Axes.matshow #10991
Conversation
lib/matplotlib/axes/_axes.py
Outdated
| Plot a matrix or array as an image. | ||
| Plot the values of a 2D matrix or array as color-coded image. | ||
|
|
||
| This is just a convenience function wrapping `.imshow` to set useful |
There was a problem hiding this comment.
I think it might be worth putting this (rather technical list) below in a notes section, since the average user probably just wants to see a matrix and not bother about imshow options.
e739a9a to
8734412
Compare
| imshow : plot an image | ||
| imshow : More general function to plot data on a 2D regular raster. | ||
|
|
||
| Notes |
There was a problem hiding this comment.
Did you want this as Notes instead of Note? Formats differently....
There was a problem hiding this comment.
Yes. I don't think this should go in a callout box ( .. note::). It's rather just an explanation, not something to watch out for.
Note: In numpydoc, there's just the short and long description and the sections (Parameters etc.) There's no way to add arbitrary content below the parameters. I.e. if we want to move this out of the way, it has to be the Notes section, which is fine.
|
@meseeksdev v2.2-doc |
|
@meeseeksdev v2.2-doc |
|
@meeseeksdev backport to v2.2-doc |
|
Something went wrong ... Please have a look at my logs. |
|
@meeseeksdev backport to v2.2.2-doc |
Backport PR #10991 on branch v2.2.2-doc
PR Summary
As part of #10148: Docstring update for
Axes.matshow.