DOC: fix description of vmin/vmax in scatter #16297
Merged
Conversation
This file contains 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
jklymak
changed the title
lib/matplotlib/axes/_axes.py
Outdated
| *norm* is only used if *c* is an array of floats. If *None*, use | ||
| the default `.colors.Normalize`. | ||
| If *c* is an array of floats, *norm* is used to scale the color | ||
| data, *c*, from 0 to 1, into order to map into the colormap *cmap*. |
There was a problem hiding this comment.
... to scale the color data, c, to the range from 0 to 1, in order to...
jklymak
force-pushed
the
doc-rephrase-scatter-vmin
branch
from
ef693bb
to
a5872c9
Compare
lib/matplotlib/axes/_axes.py
Outdated
| luminance data. If None, the respective min and max of the color | ||
| array is used. | ||
| *vmin* and *vmax* are used in conjunction with the default norm to | ||
| map the color array (*c) to the colormap (*cmap*). If None, the |
There was a problem hiding this comment.
(*c*) instead of (*c)
jklymak
force-pushed
the
doc-rephrase-scatter-vmin
branch
from
a5872c9
to
63cbb60
Compare
|
Ooops, sorry about that. Managed to push an empty branch... |
ImportanceOfBeingErnest
approved these changes
Jan 23, 2020
anntzer
reviewed
Jan 23, 2020
lib/matplotlib/axes/_axes.py
Outdated
| luminance data. If None, the respective min and max of the color | ||
| array is used. | ||
| *vmin* and *vmax* are used in conjunction with the default norm to | ||
| map the color array (*c*) to the colormap (*cmap*). If None, the |
There was a problem hiding this comment.
this actually reads fine without the parentheses too (map the color array *c* to the colormap *cmap*) -- either way is fine
There was a problem hiding this comment.
Yeah you are right. I’ll remove or if someone want to push a change that is great.
anntzer
approved these changes
Jan 23, 2020
jklymak
force-pushed
the
doc-rephrase-scatter-vmin
branch
from
2ae74ee
to
e952072
Compare
timhoffm
approved these changes
Jan 23, 2020
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
Someone on stack overflow didn't understand what
vmin/vmaxwere for, to which I was going to point them to the docs. However, the docs forscattermention the "luminance" of the data, which is not really at all whatvmin/vmaxchange. So I suggest the following changes to be a little clearer. Also its a bit strange to say vmin and vmax work with norm when their use with norm is deprecated...PR Checklist