Skip to content

Commit 9d212b3

Browse files
authored
Update docstrings for bitwise functions (#2359)
The PR updates docstrings for bitwise functions to have a blank line prior `Default` value.
1 parent 2700d92 commit 9d212b3

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

dpnp/dpnp_iface_bitwise.py

+14-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
# *****************************************************************************
2626

2727
"""
28-
Interface of the Binary operations of the DPNP
28+
Interface of the Bitwise part of the DPNP
2929
3030
Notes
3131
-----
@@ -84,6 +84,7 @@ def binary_repr(num, width=None):
8484
at least a sufficient number of bits for `num` to be represented in the
8585
designated form. If the `width` value is insufficient, an error is
8686
raised.
87+
8788
Default: ``None``.
8889
8990
Returns
@@ -145,9 +146,11 @@ def binary_repr(num, width=None):
145146
out : {None, dpnp.ndarray, usm_ndarray}, optional
146147
Output array to populate.
147148
Array must have the correct shape and the expected data type.
149+
148150
Default: ``None``.
149151
order : {"C", "F", "A", "K"}, optional
150152
Memory layout of the newly output array, if parameter `out` is ``None``.
153+
151154
Default: ``"K"``.
152155
153156
Returns
@@ -232,9 +235,11 @@ def binary_repr(num, width=None):
232235
out : {None, dpnp.ndarray, usm_ndarray}, optional
233236
Output array to populate.
234237
Array must have the correct shape and the expected data type.
238+
235239
Default: ``None``.
236240
order : {"C", "F", "A", "K"}, optional
237241
Memory layout of the newly output array, if parameter `out` is ``None``.
242+
238243
Default: ``"K"``.
239244
240245
Returns
@@ -310,9 +315,11 @@ def binary_repr(num, width=None):
310315
out : {None, dpnp.ndarray, usm_ndarray}, optional
311316
Output array to populate.
312317
Array must have the correct shape and the expected data type.
318+
313319
Default: ``None``.
314320
order : {"C", "F", "A", "K"}, optional
315321
Memory layout of the newly output array, if parameter `out` is ``None``.
322+
316323
Default: ``"K"``.
317324
318325
Returns
@@ -386,9 +393,11 @@ def binary_repr(num, width=None):
386393
out : {None, dpnp.ndarray, usm_ndarray}, optional
387394
Output array to populate.
388395
Array must have the correct shape and the expected data type.
396+
389397
Default: ``None``.
390398
order : {"C", "F", "A", "K"}, optional
391399
Memory layout of the newly output array, if parameter `out` is ``None``.
400+
392401
Default: ``"K"``.
393402
394403
Returns
@@ -472,9 +481,11 @@ def binary_repr(num, width=None):
472481
out : {None, dpnp.ndarray, usm_ndarray}, optional
473482
Output array to populate.
474483
Array must have the correct shape and the expected data type.
484+
475485
Default: ``None``.
476486
order : {"C", "F", "A", "K"}, optional
477487
Memory layout of the newly output array, if parameter `out` is ``None``.
488+
478489
Default: ``"K"``.
479490
Returns
480491
-------
@@ -549,9 +560,11 @@ def binary_repr(num, width=None):
549560
out : {None, dpnp.ndarray, usm_ndarray}, optional
550561
Output array to populate.
551562
Array must have the correct shape and the expected data type.
563+
552564
Default: ``None``.
553565
order : {"C", "F", "A", "K"}, optional
554566
Memory layout of the newly output array, if parameter `out` is ``None``.
567+
555568
Default: ``"K"``.
556569
557570
Returns

0 commit comments

Comments
 (0)