8000 Merge pull request #17002 from felixdivo/patch-2 · numpy/numpy@64619c5 · GitHub
[go: up one dir, main page]

Skip to content

Commit 64619c5

Browse files
authored
Merge pull request #17002 from felixdivo/patch-2
DOC: clip() allows arguments.
2 parents 05a88ad + 40c7e51 commit 64619c5

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

numpy/core/fromnumeric.py

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2059,15 +2059,10 @@ def clip(a, a_min, a_max, out=None, **kwargs):
20592059
----------
20602060
a : array_like
20612061
Array containing elements to clip.
2062-
a_min : scalar or array_like or None
2063-
Minimum value. If None, clipping is not performed on lower
2064-
interval edge. Not more than one of `a_min` and `a_max` may be
2065-
None.
2066-
a_max : scalar or array_like or None
2067-
Maximum value. If None, clipping is not performed on upper
2068-
interval edge. Not more than one of `a_min` and `a_max` may be
2069-
None. If `a_min` or `a_max` are array_like, then the three
2070-
arrays will be broadcasted to match their shapes.
2062+
a_min, a_max : array_like or None
2063+
Minimum and maximum value. If ``None``, clipping is not performed on
2064+
the corresponding edge. Only one of `a_min` and `a_max` may be
2065+
``None``. Both are broadcast against `a`.
20712066
out : ndarray, optional
20722067
The results will be placed in this array. It may be the input
20732068
array for in-place clipping. `out` must be of the right shape

0 commit comments

Comments
 (0)
0