diff options
| author | Felix Divo <felixdivo@users.noreply.github.com> | 2020-08-18 11:24:27 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-18 11:24:27 +0200 |
| commit | 40c7e51f61b014f84debf6ad870a8078b6df1be0 (patch) | |
| tree | 33178fa6bf21e74d0d18caf4188e997c20d369f7 | |
| parent | 8fd3473142364715285e79308c33fff534630c65 (diff) | |
| download | numpy-40c7e51f61b014f84debf6ad870a8078b6df1be0.tar.gz | |
DOC: simplify documentation of clip()
| -rw-r--r-- | numpy/core/fromnumeric.py | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index 7f5b3c2a3..b07def736 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -2059,14 +2059,10 @@ def clip(a, a_min, a_max, out=None, **kwargs): ---------- a : array_like Array containing elements to clip. - a_min : array_like or None - Minimum value. If None, clipping is not performed on lower - interval edge. Not more than one of `a_min` and `a_max` may be - None. - a_max : array_like or None - Maximum value. If None, clipping is not performed on upper - interval edge. Not more than one of `a_min` and `a_max` may be - None. `a_min` and `a_max` are broadcast against `a`. + a_min, a_max : array_like or None + Minimum and maximum value. If ``None``, clipping is not performed on + the corresponding edge. Only one of `a_min` and `a_max` may be + ``None``. Both are broadcast against `a`. out : ndarray, optional The results will be placed in this array. It may be the input array for in-place clipping. `out` must be of the right shape |