Skip to content

Commit 4c381b6

Browse files
committed
Add a blank line prior Default
1 parent 2b30bab commit 4c381b6

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

dpnp/dpnp_array.py

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ def mT(self):
121121
Raises
122122
------
123123
ValueError
124-
If the array is of dimension less than 2.
124+
If the array is of dimension less than ``2``.
125125
126126
Examples
127127
--------
@@ -212,6 +212,7 @@ def __array_namespace__(self, /, *, api_version=None):
212212
Request namespace compliant with given version of array API. If
213213
``None``, namespace for the most recent supported version is
214214
returned.
215+
215216
Default: ``None``.
216217
217218
Returns
@@ -266,19 +267,22 @@ def __dlpack__(
266267
stream : {:class:`dpctl.SyclQueue`, None}, optional
267268
Execution queue to synchronize with. If ``None``, synchronization
268269
is not performed.
270+
269271
Default: ``None``.
270272
max_version {tuple of ints, None}, optional
271273
The maximum DLPack version the consumer (caller of ``__dlpack__``)
272274
supports. As ``__dlpack__`` may not always return a DLPack capsule
273275
with version `max_version`, the consumer must verify the version
274276
even if this argument is passed.
277+
275278
Default: ``None``.
276279
dl_device {tuple, None}, optional:
277280
The device the returned DLPack capsule will be placed on. The
278281
device must be a 2-tuple matching the format of
279282
``__dlpack_device__`` method, an integer enumerator representing
280283
the device type followed by an integer representing the index of
281284
the device.
285+
282286
Default: ``None``.
283287
copy {bool, None}, optional:
284288
Boolean indicating whether or not to copy the input.
@@ -648,7 +652,7 @@ def _create_from_usm_ndarray(usm_ary: dpt.usm_ndarray):
648652

649653
def all(self, axis=None, out=None, keepdims=False, *, where=True):
650654
"""
651-
Returns True if all elements evaluate to True.
655+
Returns ``True`` if all elements evaluate to ``True.``
652656
653657
Refer to :obj:`dpnp.all` for full documentation.
654658
@@ -664,7 +668,7 @@ def all(self, axis=None, out=None, keepdims=False, *, where=True):
664668

665669
def any(self, axis=None, out=None, keepdims=False, *, where=True):
666670
"""
667-
Returns True if any of the elements of `a` evaluate to True.
671+
Returns ``True`` if any of the elements of `a` evaluate to ``True``.
668672
669673
Refer to :obj:`dpnp.any` for full documentation.
670674
@@ -714,22 +718,26 @@ def argsort(
714718
Axis along which to sort. If ``None``, the array is flattened
715719
before sorting. The default is ``-1``, which sorts along the last
716720
axis.
721+
717722
Default: ``-1``.
718723
kind : {None, "stable", "mergesort", "radixsort"}, optional
719724
Sorting algorithm. The default is ``None``, which uses parallel
720725
merge-sort or parallel radix-sort algorithms depending on the array
721726
data type.
727+
722728
Default: ``None``.
723729
descending : bool, optional
724730
Sort order. If ``True``, the array must be sorted in descending
725731
order (by value). If ``False``, the array must be sorted in
726732
ascending order (by value).
733+
727734
Default: ``False``.
728735
stable : {None, bool}, optional
729736
Sort stability. If ``True``, the returned array will maintain the
730737
relative order of `a` values which compare as equal. The same
731738
behavior applies when set to ``False`` or ``None``.
732739
Internally, this option selects ``kind="stable"``.
740+
733741
Default: ``None``.
734742
735743
See Also
@@ -928,6 +936,7 @@ def copy(self, order="C", device=None, usm_type=None, sycl_queue=None):
928936
----------
929937
order : {None, "C", "F", "A", "K"}, optional
930938
Memory layout of the newly output array.
939+
931940
Default: ``"C"``.
932941
device : {None, string, SyclDevice, SyclQueue, Device}, optional
933942
An array API concept of device where the output array is created.
@@ -940,12 +949,14 @@ def copy(self, order="C", device=None, usm_type=None, sycl_queue=None):
940949
Default: ``None``.
941950
usm_type : {None, "device", "shared", "host"}, optional
942951
The type of SYCL USM allocation for the output array.
952+
943953
Default: ``None``.
944954
sycl_queue : {None, SyclQueue}, optional
945955
A SYCL queue to use for output array allocation and copying. The
946956
`sycl_queue` can be passed as ``None`` (the default), which means
947957
to get the SYCL queue from `device` keyword if present or to use
948958
a default queue.
959+
949960
Default: ``None``.
950961
951962
Returns
@@ -1193,6 +1204,7 @@ def imag(self, value):
11931204
array([1.+9.j, 3.+9.j, 5.+9.j])
11941205
11951206
"""
1207+
11961208
if dpnp.issubdtype(self.dtype, dpnp.complexfloating):
11971209
dpnp.copyto(self._array_obj.imag, value)
11981210
else:
@@ -1658,22 +1670,26 @@ def sort(
16581670
axis : int, optional
16591671
Axis along which to sort. The default is ``-1``, which sorts along
16601672
the last axis.
1673+
16611674
Default: ``-1``.
16621675
kind : {None, "stable", "mergesort", "radixsort"}, optional
16631676
Sorting algorithm. The default is ``None``, which uses parallel
16641677
merge-sort or parallel radix-sort algorithms depending on the array
16651678
data type.
1679+
16661680
Default: ``None``.
16671681
descending : bool, optional
16681682
Sort order. If ``True``, the array must be sorted in descending
16691683
order (by value). If ``False``, the array must be sorted in
16701684
ascending order (by value).
1685+
16711686
Default: ``False``.
16721687
stable : {None, bool}, optional
16731688
Sort stability. If ``True``, the returned array will maintain the
16741689
relative order of `a` values which compare as equal. The same
16751690
behavior applies when set to ``False`` or ``None``.
16761691
Internally, this option selects ``kind="stable"``.
1692+
16771693
Default: ``None``.
16781694
16791695
See Also
@@ -1836,6 +1852,7 @@ def to_device(self, device, /, *, stream=None):
18361852
stream : {SyclQueue, None}, optional
18371853
Execution queue to synchronize with. If ``None``, synchronization
18381854
is not performed.
1855+
18391856
Default: ``None``.
18401857
18411858
Returns

0 commit comments

Comments
 (0)