Skip to content

Commit ad46975

Browse files
committed
Fix typos in the docstrings
1 parent 3eb1ff9 commit ad46975

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

dpnp/dpnp_array.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ def __array_namespace__(self, /, *, api_version=None):
151151
152152
Parameters
153153
----------
154-
api_version : str, optional
154+
api_version : {None, str}, optional
155155
Request namespace compliant with given version of array API. If
156156
``None``, namespace for the most recent supported version is
157157
returned.
@@ -223,22 +223,22 @@ def __dlpack__(
223223
is not performed.
224224
225225
Default: ``None``.
226-
max_version {tuple of ints, None}, optional
226+
max_version : {tuple of ints, None}, optional
227227
The maximum DLPack version the consumer (caller of ``__dlpack__``)
228228
supports. As ``__dlpack__`` may not always return a DLPack capsule
229229
with version `max_version`, the consumer must verify the version
230230
even if this argument is passed.
231231
232232
Default: ``None``.
233-
dl_device {tuple, None}, optional:
233+
dl_device : {tuple, None}, optional:
234234
The device the returned DLPack capsule will be placed on. The
235235
device must be a 2-tuple matching the format of
236236
``__dlpack_device__`` method, an integer enumerator representing
237237
the device type followed by an integer representing the index of
238238
the device.
239239
240240
Default: ``None``.
241-
copy {bool, None}, optional:
241+
copy : {bool, None}, optional:
242242
Boolean indicating whether or not to copy the input.
243243
244244
* If `copy` is ``True``, the input will always be copied.
@@ -251,12 +251,12 @@ def __dlpack__(
251251
252252
Raises
253253
------
254-
MemoryError:
254+
MemoryError
255255
when host memory can not be allocated.
256-
DLPackCreationError:
256+
DLPackCreationError
257257
when array is allocated on a partitioned SYCL device, or with
258258
a non-default context.
259-
BufferError:
259+
BufferError
260260
when a copy is deemed necessary but `copy` is ``False`` or when
261261
the provided `dl_device` cannot be handled.
262262
@@ -325,12 +325,12 @@ def __gt__(self, other):
325325
# '__hash__',
326326

327327
def __iadd__(self, other):
328-
"""Return :math:`self+=value`:math:."""
328+
"""Return :math:`self+=value`."""
329329
dpnp.add(self, other, out=self)
330330
return self
331331

332332
def __iand__(self, other):
333-
"""Return :math:`self&=value`:math:."""
333+
"""Return :math:`self&=value`."""
334334
dpnp.bitwise_and(self, other, out=self)
335335
return self
336336

@@ -446,7 +446,7 @@ def __lt__(self, other):
446446
return dpnp.less(self, other)
447447

448448
def __matmul__(self, other):
449-
"""Return `:math:self@value`."""
449+
"""Return :math:`self@value`."""
450450
return dpnp.matmul(self, other)
451451

452452
def __mod__(self, other):
@@ -546,7 +546,7 @@ def __rxor__(self, other):
546546
# '__setattr__',
547547

548548
def __setitem__(self, key, val):
549-
"""Set ``self[key]`` to value."""
549+
"""Set :math:`self[key]` to a value."""
550550
key = _get_unwrapped_index_key(key)
551551

552552
if isinstance(val, dpnp_array):
@@ -584,7 +584,7 @@ def __truediv__(self, other):
584584
@property
585585
def __usm_ndarray__(self):
586586
"""
587-
Property to support `__usm_ndarray__` protocol.
587+
Property to support ``__usm_ndarray__`` protocol.
588588
589589
It assumes to return :class:`dpctl.tensor.usm_ndarray` instance
590590
corresponding to the content of the object.

0 commit comments

Comments
 (0)