X Tutup
Skip to content

Clarify that Image.set_data doesn't update normalization.#8468

Merged
tacaswell merged 1 commit intomatplotlib:masterfrom
anntzer:clarify-image-set_data-norm
Apr 13, 2017
Merged

Clarify that Image.set_data doesn't update normalization.#8468
tacaswell merged 1 commit intomatplotlib:masterfrom
anntzer:clarify-image-set_data-norm

Conversation

@anntzer
Copy link
Copy Markdown
Contributor

@anntzer anntzer commented Apr 12, 2017

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.

@dstansby dstansby added this to the 2.0.1 (next bug fix release) milestone Apr 13, 2017
----------
A : array-like.

Note that this function does *not* update the normalization used.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you put this above the Parameters? Not sure how this will render with numpydoc.

@tacaswell
Copy link
Copy Markdown
Member

This is going to break how some of the summary tables render.

@anntzer anntzer force-pushed the clarify-image-set_data-norm branch from 9b93528 to 91fa7ce Compare April 13, 2017 19:00
@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Apr 13, 2017

I restored the ACCEPTS table because whatever.

@phobson
Copy link
Copy Markdown
Member

phobson commented Apr 13, 2017

I think this is fine how it is, but I wonder if we should mention how to update the normalization here.

@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Apr 13, 2017

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.

@tacaswell
Copy link
Copy Markdown
Member

Merging this as it is unquestionably an improvement

@tacaswell tacaswell merged commit 1ffd66d into matplotlib:master Apr 13, 2017
@anntzer anntzer deleted the clarify-image-set_data-norm branch April 13, 2017 23:56
tacaswell added a commit that referenced this pull request Apr 14, 2017
DOC: Clarify that Image.set_data doesn't update normalization.
@tacaswell
Copy link
Copy Markdown
Member

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

X Tutup