Skip to content

Commit 199c4f9

Browse files
committed
Replace "Returns" word with "Return" in the docstring
1 parent 7b59ad6 commit 199c4f9

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

dpnp/dpnp_array.py

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ def __array__(self, dtype=None, /, *, copy=None):
147147

148148
def __array_namespace__(self, /, *, api_version=None):
149149
"""
150-
Returns array namespace, member functions of which implement data API.
150+
Return array namespace, member functions of which implement data API.
151151
152152
Parameters
153153
----------
@@ -196,7 +196,7 @@ def __contains__(self, value, /):
196196

197197
def __copy__(self):
198198
"""
199-
Used if :func:`copy.copy` is called on an array. Returns a copy of the
199+
Used if :func:`copy.copy` is called on an array. Return a copy of the
200200
array.
201201
202202
Equivalent to ``a.copy(order="K")``.
@@ -214,7 +214,7 @@ def __dlpack__(
214214
self, /, *, stream=None, max_version=None, dl_device=None, copy=None
215215
):
216216
"""
217-
Produces DLPack capsule.
217+
Produce DLPack capsule.
218218
219219
Parameters
220220
----------
@@ -271,7 +271,7 @@ def __dlpack__(
271271

272272
def __dlpack_device__(self, /):
273273
"""
274-
Gives a tuple (``device_type``, ``device_id``) corresponding to
274+
Give a tuple (``device_type``, ``device_id``) corresponding to
275275
``DLDevice`` entry in ``DLTensor`` in DLPack protocol.
276276
277277
The tuple describes the non-partitioned device where the array has been
@@ -623,7 +623,7 @@ def _create_from_usm_ndarray(usm_ary: dpt.usm_ndarray):
623623

624624
def all(self, axis=None, *, out=None, keepdims=False, where=True):
625625
"""
626-
Returns ``True`` if all elements evaluate to ``True.``
626+
Return ``True`` if all elements evaluate to ``True.``
627627
628628
Refer to :obj:`dpnp.all` for full documentation.
629629
@@ -639,7 +639,7 @@ def all(self, axis=None, *, out=None, keepdims=False, where=True):
639639

640640
def any(self, axis=None, *, out=None, keepdims=False, where=True):
641641
"""
642-
Returns ``True`` if any of the elements of `a` evaluate to ``True``.
642+
Return ``True`` if any of the elements of `a` evaluate to ``True``.
643643
644644
Refer to :obj:`dpnp.any` for full documentation.
645645
@@ -655,7 +655,7 @@ def any(self, axis=None, *, out=None, keepdims=False, where=True):
655655

656656
def argmax(self, /, axis=None, out=None, *, keepdims=False):
657657
"""
658-
Returns array of indices of the maximum values along the given axis.
658+
Return array of indices of the maximum values along the given axis.
659659
660660
Refer to :obj:`dpnp.argmax` for full documentation.
661661
@@ -1076,7 +1076,7 @@ def dot(self, b, out=None):
10761076
@property
10771077
def dtype(self):
10781078
"""
1079-
Returns NumPy's dtype corresponding to the type of the array elements.
1079+
Return NumPy's dtype corresponding to the type of the array elements.
10801080
10811081
""" # noqa: D200
10821082

@@ -1309,7 +1309,7 @@ def mean(
13091309
self, /, axis=None, dtype=None, *, out=None, keepdims=False, where=True
13101310
):
13111311
"""
1312-
Returns the average of the array elements.
1312+
Return the average of the array elements.
13131313
13141314
Refer to :obj:`dpnp.mean` for full documentation.
13151315
@@ -1478,7 +1478,7 @@ def prod(
14781478
where=True,
14791479
):
14801480
"""
1481-
Returns the prod along a given axis.
1481+
Return the prod along a given axis.
14821482
14831483
Refer to :obj:`dpnp.prod` for full documentation.
14841484
@@ -1496,7 +1496,7 @@ def prod(
14961496

14971497
def put(self, /, indices, vals, axis=None, mode="wrap"):
14981498
"""
1499-
Puts values of an array into another array along a given axis.
1499+
Put values of an array into another array along a given axis.
15001500
15011501
Refer to :obj:`dpnp.put` for full documentation.
15021502
@@ -1567,7 +1567,7 @@ def repeat(self, repeats, axis=None):
15671567

15681568
def reshape(self, /, *shape, order="C", copy=None):
15691569
"""
1570-
Returns an array containing the same data with a new shape.
1570+
Return an array containing the same data with a new shape.
15711571
15721572
Refer to :obj:`dpnp.reshape` for full documentation.
15731573
@@ -1821,7 +1821,7 @@ def std(
18211821
correction=None,
18221822
):
18231823
"""
1824-
Returns the standard deviation of the array elements, along given axis.
1824+
Return the standard deviation of the array elements, along given axis.
18251825
18261826
Refer to :obj:`dpnp.std` for full documentation.
18271827
@@ -1842,7 +1842,7 @@ def std(
18421842
@property
18431843
def strides(self):
18441844
"""
1845-
Returns memory displacement in array elements, upon unit
1845+
Return memory displacement in array elements, upon unit
18461846
change of respective index.
18471847
18481848
For example, for strides ``(s1, s2, s3)`` and multi-index
@@ -1865,7 +1865,7 @@ def sum(
18651865
where=True,
18661866
):
18671867
"""
1868-
Returns the sum along a given axis.
1868+
Return the sum along a given axis.
18691869
18701870
Refer to :obj:`dpnp.sum` for full documentation.
18711871
@@ -1960,7 +1960,7 @@ def take(self, indices, axis=None, *, out=None, mode="wrap"):
19601960

19611961
def to_device(self, device, /, *, stream=None):
19621962
"""
1963-
Transfers this array to specified target device.
1963+
Transfer this array to specified target device.
19641964
19651965
Parameters
19661966
----------
@@ -2020,7 +2020,7 @@ def trace(self, offset=0, axis1=0, axis2=1, dtype=None, *, out=None):
20202020

20212021
def transpose(self, *axes):
20222022
"""
2023-
Returns a view of the array with axes transposed.
2023+
Return a view of the array with axes transposed.
20242024
20252025
For full documentation refer to :obj:`numpy.ndarray.transpose`.
20262026
@@ -2102,7 +2102,7 @@ def var(
21022102
correction=None,
21032103
):
21042104
"""
2105-
Returns the variance of the array elements, along given axis.
2105+
Return the variance of the array elements, along given axis.
21062106
21072107
Refer to :obj:`dpnp.var` for full documentation.
21082108

0 commit comments

Comments
 (0)