[Doc] Small fixes found by velin #26705
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
oscargus
commented
Sep 6, 2023
| image to. | ||
| hsv_max_sat : number, default: 0 | ||
| The maximum saturation value that the *intensity* map can shift the output | ||
| image to. |
There was a problem hiding this comment.
I do not know enough about HSV saturation, but it seems a bit "weird" that the min value is larger than the max value...
There was a problem hiding this comment.
It does seem odd, but the blend_hsv function docstring below says:
The default extremes are
chose so that completely shaded points are nearly black (s = 1, v = 0)
and completely illuminated points are nearly white (s = 0, v = 1).
So, I think this is expected although unintuitive at first glance.
oscargus
added
Documentation: API
greglucas
approved these changes
Sep 7, 2023
| image to. | ||
| hsv_max_sat : number, default: 0 | ||
| The maximum saturation value that the *intensity* map can shift the output | ||
| image to. |
There was a problem hiding this comment.
It does seem odd, but the blend_hsv function docstring below says:
The default extremes are
chose so that completely shaded points are nearly black (s = 1, v = 0)
and completely illuminated points are nearly white (s = 0, v = 1).
So, I think this is expected although unintuitive at first glance.
ksunden
reviewed
Sep 11, 2023
timhoffm
approved these changes
Sep 11, 2023
ksunden
approved these changes
Sep 12, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 12, 2023
oscargus
added a commit
that referenced
this pull request
Sep 12, 2023
…705-on-v3.8.x Backport PR #26705 on branch v3.8.x ([Doc] Small fixes found by velin)
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
PR checklist