diff options
author | Felix Berkenkamp <befelix@ethz.ch> | 2017-01-15 19:36:44 +0100 |
---|---|---|
committer | Felix Berkenkamp <befelix@ethz.ch> | 2017-01-15 19:36:44 +0100 |
commit | 663bc5680b1d1d4954f71e7f02f40d0daf6b4209 (patch) | |
tree | 94a76fba699031e048c854f87aec900c401a6edf /numpy/core/fromnumeric.py | |
parent | d9c1a1f91a3983469de7086ff589a6aeaa353b3e (diff) | |
download | numpy-663bc5680b1d1d4954f71e7f02f40d0daf6b4209.tar.gz |
DOC: improve clip docstring
Diffstat (limited to 'numpy/core/fromnumeric.py')
-rw-r--r-- | numpy/core/fromnumeric.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index 4cb78e3fc..a2159405c 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -1670,8 +1670,8 @@ def clip(a, a_min, a_max, out=None): a_min : scalar or array_like Minimum value. a_max : scalar or array_like - Maximum value. If `a_min` or `a_max` are array_like, then they will - be broadcasted to the shape of `a`. + Maximum value. If `a_min` or `a_max` are array_like, then the + three arrays will be broadcasted to match their shapes. 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 @@ -1700,7 +1700,7 @@ def clip(a, a_min, a_max, out=None): >>> a = np.arange(10) >>> a array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]) - >>> np.clip(a, [3,4,1,1,1,4,4,4,4,4], 8) + >>> np.clip(a, [3, 4, 1, 1, 1, 4, 4, 4, 4, 4], 8) array([3, 4, 2, 3, 4, 5, 6, 7, 8, 8]) """ |