DOC: Update documentation of np.clip #15124
Merged
Conversation
This file contains hidden or 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
numpy/core/fromnumeric.py
Outdated
| @@ -2033,7 +2033,8 @@ def clip(a, a_min, a_max, out=None, **kwargs): | ||
| is specified, values smaller than 0 become 0, and values larger | ||
| than 1 become 1. | ||
|
|
||
| Equivalent to but faster than ``np.maximum(a_min, np.minimum(a, a_max))``. | ||
| Equivalent to but faster than ``np.maximum(a_min, np.minimum(a, a_max))`` | ||
| only if ``a_min < a_max`` else returns ``a_max``. |
There was a problem hiding this comment.
I'd be surprised if it were this straightforward, but happy to be wrong :)
I though it was more like if amin > amax, strange things can happen depending on the nature of the input.
There was a problem hiding this comment.
Maybe simply "Assumes a_min < a_max"
There was a problem hiding this comment.
I think it actually is this straightforward (whereas it didn't use to be). Bring deliberately vague here is probably good anyway though.
|
Thanks @Bharat123rox |
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.
Fixes #15061 by informing users and updating the documentation of np.clip