diff options
| author | Muhammad Jarir Kanji <52061313+mjkanji@users.noreply.github.com> | 2022-10-01 05:49:54 +0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-30 17:49:54 -0700 |
| commit | 1260b5293f8efacaa902fe33d6dc82d3ddc638bb (patch) | |
| tree | ade48d047807e0cbdee36b6eda0fd5e8da4353c2 /numpy/core/fromnumeric.py | |
| parent | 9b94c6fed78d8aaf358f7552c17754037b3bf320 (diff) | |
| download | numpy-1260b5293f8efacaa902fe33d6dc82d3ddc638bb.tar.gz | |
DOC: Update amin/amax return description. (#22362)
Update return description to account for case when axis is a tuple
of integers, noting the shape of the returned array.
Diffstat (limited to 'numpy/core/fromnumeric.py')
| -rw-r--r-- | numpy/core/fromnumeric.py | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index f4c7af88a..89d731e32 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -2750,8 +2750,9 @@ def amax(a, axis=None, out=None, keepdims=np._NoValue, initial=np._NoValue, ------- amax : ndarray or scalar Maximum of `a`. If `axis` is None, the result is a scalar value. - If `axis` is given, the result is an array of dimension - ``a.ndim - 1``. + If `axis` is an int, the result is an array of dimension + ``a.ndim - 1``. If `axis` is a tuple, the result is an array of + dimension ``a.ndim - len(axis)``. See Also -------- @@ -2875,8 +2876,9 @@ def amin(a, axis=None, out=None, keepdims=np._NoValue, initial=np._NoValue, ------- amin : ndarray or scalar Minimum of `a`. If `axis` is None, the result is a scalar value. - If `axis` is given, the result is an array of dimension - ``a.ndim - 1``. + If `axis` is an int, the result is an array of dimension + ``a.ndim - 1``. If `axis` is a tuple, the result is an array of + dimension ``a.ndim - len(axis)``. See Also -------- |