Minor tweaks to image docs. #29184
Merged
Minor tweaks to image docs. #29184
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timhoffm
approved these changes
Nov 25, 2024
Comment on lines
+237
to
247
| *interpolation* and *cmap* default to their rc settings. | ||
|
|
||
| cmap is a colors.Colormap instance | ||
| norm is a colors.Normalize instance to map luminance to 0-1 | ||
| *cmap* is a `.colors.Colormap` instance. | ||
| *norm* is a `.colors.Normalize` instance to map luminance to 0-1. | ||
|
|
||
| extent is data axes (left, right, bottom, top) for making image plots | ||
| registered with data plots. Default is to label the pixel | ||
| centers with the zero-based row and column indices. | ||
| *extent* is a ``(left, right, bottom, top)`` tuple in data coordinates, for | ||
| making image plots registered with data plots; the default is to label the | ||
| pixel centers with the zero-based row and column indices. | ||
|
|
||
| Additional kwargs are matplotlib.artist properties | ||
| Additional kwargs are `.Artist` properties. | ||
| """ |
There was a problem hiding this comment.
This is an improvement, so ok. But actually, this should be a formal "Parameters" section.
There was a problem hiding this comment.
I know, but I didn't really want to go through rewriting the whole thing, so I'll self-merge.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR summary
PR checklist