Skip to content
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.

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

Clarify doc for "norm" kwarg to imshow. #6826

Merged
merged 1 commit into from Jul 25, 2016

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jul 24, 2016

"norm" also applies when X is a 2D-array of integers -- i.e, similarly
to the "cmap" kwarg. Make the docs for the two kwargs consistent.

@efiring
Copy link
Member

efiring commented Jul 25, 2016

There is more that needs to be fixed in the imshow docstring. It is not taking into account that MxN can be an integer array if norm is NoNorm. Also the "luminance (grayscale...)" is confusing, since it is generally not intended to indicate gray, and it is not really luminance--it is simply the input to the (norm, cmap) combination.

@anntzer
Copy link
Contributor Author

anntzer commented Jul 25, 2016

(If you have specific edits to suggest, please post them as diffs (or PR to my repo but that's a bit overkill).)

@efiring
Copy link
Member

efiring commented Jul 25, 2016

Here's a diff for _axes.imshow:
imshow_Xdoc_diff.txt
Of course, looking down a little farther one sees no end of other docstrings needing work.
It would be nice to be able to factor out some of the common chunks, such as the descriptions of cmap and norm.

"norm" also applies when X is a 2D-array of integers -- i.e, similarly
to the "cmap" kwarg.  Make the docs for the two kwargs consistent.
@anntzer anntzer force-pushed the clarify-imshow-norm-docstring branch from e5ec7a5 to 16abfd3 Compare July 25, 2016 01:53
@tacaswell tacaswell modified the milestone: 2.0 (style change major release) Jul 25, 2016
@tacaswell tacaswell merged commit bae8333 into matplotlib:master Jul 25, 2016
tacaswell added a commit that referenced this pull request Jul 25, 2016
DOC: Clarify doc for "norm" kwarg to `imshow`.
@tacaswell
Copy link
Member

backported to v2.x as 4c4ead5

@anntzer anntzer deleted the clarify-imshow-norm-docstring branch July 25, 2016 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants