Clarify that Image.set_data doesn't update normalization. #8468
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
dstansby
approved these changes
Apr 13, 2017
tacaswell
reviewed
Apr 13, 2017
lib/matplotlib/image.py
Outdated
| ---------- | ||
| A : array-like. | ||
|
|
||
| Note that this function does *not* update the normalization used. |
There was a problem hiding this comment.
Can you put this above the Parameters? Not sure how this will render with numpydoc.
|
This is going to break how some of the summary tables render. |
9b93528 to
91fa7ce
Compare
|
I restored the ACCEPTS table because whatever. |
dstansby
approved these changes
Apr 13, 2017
|
I think this is fine how it is, but I wonder if we should mention how to update the normalization here. |
|
I don't mind adding a See Also section but then someone needs to address how the ACCEPTS array interact with numpydoc, as mentioned by @tacaswell above. |
|
Merging this as it is unquestionably an improvement |
tacaswell
added a commit
that referenced
this pull request
Apr 14, 2017
DOC: Clarify that Image.set_data doesn't update normalization.
|
backported to v2.0.x as 6e087ea |
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.
See #8467.
PIL images are array-likes (in the sense that they can be passed to
asarray) so we don't need to mention them explicitly.