Skip to content

Commit 63e945a

Browse files
committed
Align out docstring (state None value)
1 parent 80111be commit 63e945a

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

dpnp/dpnp_iface.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,7 @@ def get_result_array(a, out=None, casting="safe"):
572572
----------
573573
a : {dpnp.ndarray, usm_ndarray}
574574
Input array.
575-
out : {dpnp.ndarray, usm_ndarray}
575+
out : {None, dpnp.ndarray, usm_ndarray}
576576
If provided, value of `a` array will be copied into it
577577
according to ``safe`` casting rule.
578578
It should be of the appropriate shape.
@@ -585,7 +585,7 @@ def get_result_array(a, out=None, casting="safe"):
585585
586586
Returns
587587
-------
588-
out : {dpnp_array}
588+
out : dpnp.ndarray
589589
Return `out` if provided, otherwise return `a`.
590590
591591
"""

dpnp/dpnp_iface_arraycreation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3559,7 +3559,7 @@ def trace(a, offset=0, axis1=0, axis2=1, dtype=None, out=None):
35593559
precision, then the default integer precision is used. Otherwise, the
35603560
precision is the same as that of `a`.
35613561
Default: ``None``.
3562-
out : {dpnp.ndarray, usm_ndarray}, optional
3562+
out : {None, dpnp.ndarray, usm_ndarray}, optional
35633563
Array into which the output is placed. Its type is preserved and it
35643564
must be of the right shape to hold the output.
35653565
Default: ``None``.

dpnp/dpnp_utils/dpnp_utils_linearalgebra.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def _compute_res_dtype(*arrays, sycl_queue, dtype=None, out=None, casting="no"):
6666
Input arrays.
6767
dtype : dtype
6868
If not ``None`` and `out` is not defined, data type of the output array.
69-
out : {dpnp.ndarray, usm_ndarray}
69+
out : {out, dpnp.ndarray, usm_ndarray}
7070
If not ``None``, data type of the output array.
7171
casting : {"no", "equiv", "safe", "same_kind", "unsafe"}, optional
7272
Controls what kind of data casting may occur.
@@ -75,7 +75,7 @@ def _compute_res_dtype(*arrays, sycl_queue, dtype=None, out=None, casting="no"):
7575
7676
Returns
7777
-------
78-
res_dtype :
78+
res_dtype : dtype
7979
`res_dtype` is the output data type. When the result is obtained,
8080
it is cast to `res_dtype`.
8181

0 commit comments

Comments
 (0)