diff options
| author | Matti Picus <matti.picus@gmail.com> | 2020-08-19 13:40:55 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-19 13:40:55 +0300 |
| commit | 64619c55896dad1927afe78c0702a58abf0d038f (patch) | |
| tree | d6163bf9b536ef87c3d66dacf34789f171fa389f /numpy/core/fromnumeric.py | |
| parent | 05a88ad2aacd16f8e38a44fece6588f6ee840a32 (diff) | |
| parent | 40c7e51f61b014f84debf6ad870a8078b6df1be0 (diff) | |
| download | numpy-64619c55896dad1927afe78c0702a58abf0d038f.tar.gz | |
Merge pull request #17002 from felixdivo/patch-2
DOC: clip() allows arguments.
Diffstat (limited to 'numpy/core/fromnumeric.py')
| -rw-r--r-- | numpy/core/fromnumeric.py | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index f8c11c015..b07def736 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -2059,15 +2059,10 @@ def clip(a, a_min, a_max, out=None, **kwargs): ---------- a : array_like Array containing elements to clip. - a_min : scalar or 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 : scalar or 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. If `a_min` or `a_max` are array_like, then the three - arrays will be broadcasted to match their shapes. + 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 |