Skip to content

Commit 80111be

Browse files
committed
Align keepdims docstring (state None value)
1 parent 1b0ce60 commit 80111be

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

dpnp/dpnp_iface_logic.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ def all(a, /, axis=None, out=None, keepdims=False, *, where=True):
103103
the same shape as the expected output but the type (of the returned
104104
values) will be cast if necessary.
105105
Default: ``None``.
106-
keepdims : bool, optional
106+
keepdims : {None, bool}, optional
107107
If ``True``, the reduced axes (dimensions) are included in the result
108108
as singleton dimensions, so that the returned array remains
109109
compatible with the input array according to Array Broadcasting
@@ -275,7 +275,7 @@ def any(a, /, axis=None, out=None, keepdims=False, *, where=True):
275275
the same shape as the expected output but the type (of the returned
276276
values) will be cast if necessary.
277277
Default: ``None``.
278-
keepdims : bool, optional
278+
keepdims : {None, bool}, optional
279279
If ``True``, the reduced axes (dimensions) are included in the result
280280
as singleton dimensions, so that the returned array remains
281281
compatible with the input array according to Array Broadcasting

dpnp/dpnp_iface_nanfunctions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -682,7 +682,7 @@ def nanmedian(a, axis=None, out=None, overwrite_input=False, keepdims=False):
682682
but it will probably be fully or partially sorted.
683683
684684
Default: ``False``.
685-
keepdims : bool, optional
685+
keepdims : {None, bool}, optional
686686
If ``True``, the reduced axes (dimensions) are included in the result
687687
as singleton dimensions, so that the returned array remains
688688
compatible with the input array according to Array Broadcasting

dpnp/dpnp_iface_statistics.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1125,7 +1125,7 @@ def median(a, axis=None, out=None, overwrite_input=False, keepdims=False):
11251125
but it will probably be fully or partially sorted.
11261126
11271127
Default: ``False``.
1128-
keepdims : bool, optional
1128+
keepdims : {None, bool}, optional
11291129
If ``True``, the reduced axes (dimensions) are included in the result
11301130
as singleton dimensions, so that the returned array remains
11311131
compatible with the input array according to Array Broadcasting

dpnp/linalg/dpnp_iface_linalg.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -962,7 +962,7 @@ def matrix_norm(x, /, *, keepdims=False, ord="fro"):
962962
x : {dpnp.ndarray, usm_ndarray}
963963
Input array having shape (..., M, N) and whose two innermost
964964
dimensions form ``MxN`` matrices.
965-
keepdims : bool, optional
965+
keepdims : {None, bool}, optional
966966
If this is set to ``True``, the axes which are normed over are left in
967967
the result as dimensions with size one. With this option the result
968968
will broadcast correctly against the original `x`.
@@ -1290,7 +1290,7 @@ def norm(x, ord=None, axis=None, keepdims=False):
12901290
`x` is 1-D) or a matrix norm (when `x` is 2-D) is returned.
12911291
12921292
Default: ``None``.
1293-
keepdims : bool, optional
1293+
keepdims : {None, bool}, optional
12941294
If this is set to ``True``, the axes which are normed over are left in
12951295
the result as dimensions with size one. With this option the result
12961296
will broadcast correctly against the original `x`.
@@ -2336,7 +2336,7 @@ def vector_norm(x, /, *, axis=None, keepdims=False, ord=2):
23362336
equivalent to computing the vector norm of a flattened array).
23372337
23382338
Default: ``None``.
2339-
keepdims : bool, optional
2339+
keepdims : {None, bool}, optional
23402340
If this is set to ``True``, the axes which are normed over are left in
23412341
the result as dimensions with size one. With this option the result
23422342
will broadcast correctly against the original `x`.

0 commit comments

Comments
 (0)