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

Update imshow docs. #13336

Merged
merged 1 commit into from Feb 1, 2019
Merged

Update imshow docs. #13336

merged 1 commit into from Feb 1, 2019

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jan 31, 2019

  • Reword a bit description of X argument. Note that any integer
    data, even if not uint8, is interpreted as 0-255 uint8 (with clipping
    to that range).
  • Move the doc for norm up to its position in the signature (right
    after cmap). Reword the docs for cmap and norm to be phrased
    more similarly.
  • Move the doc for alpha up to its position in the signature (before
    vmin, vmax).

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

- Reword a bit description of X argument.  Note that *any* integer
  data, even if not uint8, is interpreted as 0-255 uint8 (with clipping
  to that range).
- Move the doc for `norm` up to its position in the signature (right
  after `cmap`).  Reword the docs for `cmap` and `norm` to be phrased
  more similarly.
- Move the doc for `alpha` up to its position in the signature (before
  `vmin`, `vmax`).
@tacaswell tacaswell added this to the v3.1 milestone Feb 1, 2019
@tacaswell tacaswell merged commit 8219a14 into matplotlib:master Feb 1, 2019
@anntzer anntzer deleted the imshow branch February 1, 2019 04:40
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

2 participants