DOC: Clarify description and add examples in colors.Normalize #26915
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
Co-authored-by: Zihao Yang zihaoyng@gmail.com
jklymak
reviewed
Sep 25, 2023
anntzer
reviewed
Sep 25, 2023
Co-authored-by: Zihao Yang zihaoyng@gmail.com
|
Updated with the suggestions. |
timhoffm
reviewed
Sep 27, 2023
lib/matplotlib/colors.py
Outdated
Comment on lines
1218
to
1220
| A class which, when called, maps data values within the interval | ||
| ``[vmin, vmax]`` linearly to fit within the interval ``[0.0, 1.0]``. Data | ||
| with values outside ``[vmin, vmax]`` will be mapped based on *clip*. |
There was a problem hiding this comment.
Minor wording suggestions to be more concise (data values -> values, map to fit within the interval -> map to the interval, ...)
Suggested change
| A class which, when called, maps data values within the interval | |
| ``[vmin, vmax]`` linearly to fit within the interval ``[0.0, 1.0]``. Data | |
| with values outside ``[vmin, vmax]`` will be mapped based on *clip*. | |
| A class which, when called, maps values within the interval | |
| ``[vmin, vmax]`` linearly to the interval ``[0.0, 1.0]``. The mapping of | |
| values outside ``[vmin, vmax]`` depends on *clip*. |
lib/matplotlib/colors.py
Outdated
Comment on lines
1226
to
1233
| # [0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0] | ||
| x = np.linspace(0, 1, 11) | ||
|
|
||
| norm = mpl.colors.Normalize(vmin=0.2, vmax=0.6, clip=False) | ||
| norm(x) # [-0.5, -0.25, 0, 0.25, 0.5, 0.75, 1.0, 1.25, 1.5, 1.75, 2.0] | ||
|
|
||
| norm = mpl.colors.Normalize(vmin=0.2, vmax=0.6, clip=True) | ||
| norm(x) # [0, 0, 0, 0.25, 0.5, 0.75, 1.0, 1.0, 1.0, 1.0, 1.0] |
There was a problem hiding this comment.
It may be confusing to choose the actual x range to be [0, 1] which is incidentally the target range of the Norm, but is completely unrelated. These numbers may make the effect more obvious
Suggested change
| # [0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0] | |
| x = np.linspace(0, 1, 11) | |
| norm = mpl.colors.Normalize(vmin=0.2, vmax=0.6, clip=False) | |
| norm(x) # [-0.5, -0.25, 0, 0.25, 0.5, 0.75, 1.0, 1.25, 1.5, 1.75, 2.0] | |
| norm = mpl.colors.Normalize(vmin=0.2, vmax=0.6, clip=True) | |
| norm(x) # [0, 0, 0, 0.25, 0.5, 0.75, 1.0, 1.0, 1.0, 1.0, 1.0] | |
| x = [-2, -1, 0, 1, 2] | |
| norm = mpl.colors.Normalize(vmin=-1, vmax=1, clip=False) | |
| norm(x) # [-0.5, 0., 0.5, 1., 1.5] | |
| norm = mpl.colors.Normalize(vmin=-1, vmax=1, clip=True) | |
| norm(x) # [0., 0., 0.5, 1., 1.] |
lib/matplotlib/colors.py
Outdated
| @@ -1410,7 +1444,7 @@ def autoscale_None(self, A): | |||
| self.vmax = A.max() | |||
|
|
|||
| def scaled(self): | |||
| """Return whether vmin and vmax are set.""" | |||
| """Return whether vim and max are both set""" | |||
There was a problem hiding this comment.
Suggested change
| """Return whether vim and max are both set""" | |
| """Return whether vim and max are both set.""" |
There was a problem hiding this comment.
Thanks for the very helpful suggestions!
Co-authored-by: Zihao Yang zihaoyng@gmail.com
timhoffm
approved these changes
Sep 28, 2023
|
Thanks @stevezhang1999 ! |
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.
Co-authored-by: Zihao Yang zihaoyng@gmail.com
PR summary
The original description is not easy to understand for us (without playing with the API) so we tried to make it more clear and added some examples. Also we added documentation for methods that are not documented - we found some description about the methods issue tracker's threads!
PR checklist