8000 DOC: Fix type of axis in nanfunctions (#10421) · numpy/numpy@7210768 · GitHub
[go: up one dir, main page]

Skip to content

Commit 7210768

Browse files
Tobias-Fischereric-wieser
authored andcommitted
DOC: Fix type of axis in nanfunctions (#10421)
1 parent 2854d50 commit 7210768

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

numpy/lib/nanfunctions.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,8 @@ def nanmin(a, axis=None, out=None, keepdims=np._NoValue):
198198
a : array_like
199199
Array containing numbers whose minimum is desired. If `a` is not an
200200
array, a conversion is attempted.
201-
axis : int, optional
202-
Axis along which the minimum is computed. The default is to compute
201+
axis : {int, tuple of int, None}, optional
202+
Axis or axes along which the minimum is computed. The default is to compute
203203
the minimum of the flattened array.
204204
out : ndarray, optional
205205
Alternate output array in which to place the result. The default
@@ -306,8 +306,8 @@ def nanmax(a, axis=None, out=None, keepdims=np._NoValue):
306306
a : array_like
307307
Array containing numbers whose maximum is desired. If `a` is not an
308308
array, a conversion is attempted.
309-
axis : int, optional
310-
Axis along which the maximum is computed. The default is to compute
309+
axis : {int, tuple of int, None}, optional
310+
Axis or axes along which the maximum is computed. The default is to compute
311311
the maximum of the flattened array.
312312
out : ndarray, optional
313313
Alternate output array in which to place the result. The default
@@ -505,8 +505,8 @@ def nansum(a, axis=None, dtype=None, out=None, keepdims=np._NoValue):
505505
a : array_like
506506
Array containing numbers whose sum is desired. If `a` is not an
507507
array, a conversion is attempted.
508-
axis : int, optional
509-
Axis along which the sum is computed. The default is to compute the
508+
axis : {int, tuple of int, None}, optional
509+
Axis or axes along which the sum is computed. The default is to compute the
510510
sum of the flattened array.
511511
dtype : data-type, optional
512512
The type of the returned array and of the accumulator in which the
@@ -596,8 +596,8 @@ def nanprod(a, axis=None, dtype=None, out=None, keepdims=np._NoValue):
596596
a : array_like
597597
Array containing numbers whose product is desired. If `a` is not an
598598
array, a conversion is attempted.
599-
axis : int, optional
600-
Axis along which the product is computed. The default is to compute
599+
axis : {int, tuple of int, None}, optional
600+
Axis or axes along which the product is computed. The default is to compute
601601
the product of the flattened array.
602602
dtype : data-type, optional
603603
The type of the returned array and of the accumulator in which the
@@ -791,8 +791,8 @@ def nanmean(a, axis=None, dtype=None, out=None, keepdims=np._NoValue):
791791
a : array_like
792792
Array containing numbers whose mean is desired. If `a` is not an
793793
array, a conversion is attempted.
794-
axis : int, optional
795-
Axis along which the means are computed. The default is to compute
794+
axis : {int, tuple of int, None}, optional
795+
Axis or axes along which the means are computed. The default is to compute
796796
the mean of the flattened array.
797797
dtype : data-type, optional
798798
Type to use in computing the mean. For integer inputs, the default
@@ -1217,8 +1217,8 @@ def nanvar(a, axis=None, dtype=None, out=None, ddof=0, keepdims=np._NoValue):
12171217
a : array_like
12181218
Array containing numbers whose variance is desired. If `a` is not an
12191219
array, a conversion is attempted.
1220-
axis : int, optional
1221-
Axis along which the variance is computed. The default is to compute
1220+
axis : {int, tuple of int, None}, optional
1221+
Axis or axes along which the variance is computed. The default is to compute
12221222
the variance of the flattened array.
12231223
dtype : data-type, optional
12241224
Type to use in computing the variance. For arrays of integer type
@@ -1359,8 +1359,8 @@ def nanstd(a, axis=None, dtype=None, out=None, ddof=0, keepdims=np._NoValue):
13591359
----------
13601360
a : array_like
13611361
Calculate the standard deviation of the non-NaN values.
1362-
axis : int, optional
1363-
Axis along which the standard deviation is computed. The default is
1362+
axis : {int, tuple of int, None}, optional
1363+
Axis or axes along which the standard deviation is computed. The default is
13641364
to compute the standard deviation of the flattened array.
13651365
dtype : dtype, optional
13661366
Type to use in computing the standard deviation. For arrays of

0 commit comments

Comments
 (0)
0