Skip to content

Commit c5624b7

Browse files
committed
Fix typos in the docstrings
1 parent 2a10fb3 commit c5624b7

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.
@@ -221,22 +221,22 @@ def __dlpack__(
221221
is not performed.
222222
223223
Default: ``None``.
224-
max_version {tuple of ints, None}, optional
224+
max_version : {tuple of ints, None}, optional
225225
The maximum DLPack version the consumer (caller of ``__dlpack__``)
226226
supports. As ``__dlpack__`` may not always return a DLPack capsule
227227
with version `max_version`, the consumer must verify the version
228228
even if this argument is passed.
229229
230230
Default: ``None``.
231-
dl_device {tuple, None}, optional:
231+
dl_device : {tuple, None}, optional:
232232
The device the returned DLPack capsule will be placed on. The
233233
device must be a 2-tuple matching the format of
234234
``__dlpack_device__`` method, an integer enumerator representing
235235
the device type followed by an integer representing the index of
236236
the device.
237237
238238
Default: ``None``.
239-
copy {bool, None}, optional:
239+
copy : {bool, None}, optional:
240240
Boolean indicating whether or not to copy the input.
241241
242242
* If `copy` is ``True``, the input will always be copied.
@@ -249,12 +249,12 @@ def __dlpack__(
249249
250250
Raises
251251
------
252-
MemoryError:
252+
MemoryError
253253
when host memory can not be allocated.
254-
DLPackCreationError:
254+
DLPackCreationError
255255
when array is allocated on a partitioned SYCL device, or with
256256
a non-default context.
257-
BufferError:
257+
BufferError
258258
when a copy is deemed necessary but `copy` is ``False`` or when
259259
the provided `dl_device` cannot be handled.
260260
@@ -323,12 +323,12 @@ def __gt__(self, other):
323323
# '__hash__',
324324

325325
def __iadd__(self, other):
326-
"""Return :math:`self+=value`:math:."""
326+
"""Return :math:`self+=value`."""
327327
dpnp.add(self, other, out=self)
328328
return self
329329

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

@@ -444,7 +444,7 @@ def __lt__(self, other):
444444
return dpnp.less(self, other)
445445

446446
def __matmul__(self, other):
447-
"""Return `:math:self@value`."""
447+
"""Return :math:`self@value`."""
448448
return dpnp.matmul(self, other)
449449

450450
def __mod__(self, other):
@@ -544,7 +544,7 @@ def __rxor__(self, other):
544544
# '__setattr__',
545545

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

550550
if isinstance(val, dpnp_array):
@@ -582,7 +582,7 @@ def __truediv__(self, other):
582582
@property
583583
def __usm_ndarray__(self):
584584
"""
585-
Property to support `__usm_ndarray__` protocol.
585+
Property to support ``__usm_ndarray__`` protocol.
586586
587587
It assumes to return :class:`dpctl.tensor.usm_ndarray` instance
588588
corresponding to the content of the object.

0 commit comments

Comments
 (0)