8000 DOC: simplify documentation of clip() · numpy/numpy@40c7e51 · GitHub
[go: up one dir, main page]

Skip to content

Commit 40c7e51

Browse files
authored
DOC: simplify documentation of clip()
1 parent 8fd3473 commit 40c7e51

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

numpy/core/fromnumeric.py

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2059,14 +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 : 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 : 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. `a_min` and `a_max` are broadcast against `a`.
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`.
20702066
out : ndarray, optional
20712067
The results will be placed in this array. It may be the input
20722068
array for in-place clipping. `out` must be of the right shape

0 commit comments

Comments
 (0)
0