Skip to content

Commit fec8bc0

Browse files
antonwolfyantonwolfy
committed
Align order docstring (state None value)
1 parent 8018fd4 commit fec8bc0

8 files changed

+100
-100
lines changed

‎dpnp/dpnp_array.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -926,7 +926,7 @@ def copy(self, order="C", device=None, usm_type=None, sycl_queue=None):
926926
927927
Parameters
928928
----------
929-
order : {"C", "F", "A", "K"}, optional
929+
order : {None, "C", "F", "A", "K"}, optional
930930
Memory layout of the newly output array.
931931
Default: ``"C"``.
932932
device : {None, string, SyclDevice, SyclQueue, Device}, optional

‎dpnp/dpnp_iface_arraycreation.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ def array(
320320
(``dtype``, ``order``, etc.). For ``False`` it raises a ``ValueError``
321321
exception if a copy can not be avoided.
322322
Default: ``True``.
323-
order : {"C", "F", "A", "K"}, optional
323+
order : {None, "C", "F", "A", "K"}, optional
324324
Memory layout of the newly output array.
325325
Default: ``"K"``.
326326
ndmin : int, optional
@@ -998,7 +998,7 @@ def copy(
998998
Input data, in any form that can be converted to an array. This
999999
includes scalars, lists, lists of tuples, tuples, tuples of tuples,
10001000
tuples of lists, and ndarrays.
1001-
order : {"C", "F", "A", "K"}, optional
1001+
order : {None, "C", "F", "A", "K"}, optional
10021002
Memory layout of the newly output array.
10031003
Default: ``"K"``.
10041004
device : {None, string, SyclDevice, SyclQueue, Device}, optional

‎dpnp/dpnp_iface_bitwise.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ def binary_repr(num, width=None):
150150
Array must have the correct shape and the expected data type.
151151
152152
Default: ``None``.
153-
order : {"C", "F", "A", "K"}, optional
153+
order : {None, "C", "F", "A", "K"}, optional
154154
Memory layout of the newly output array, if parameter `out` is ``None``.
155155
156156
Default: ``"K"``.
@@ -231,7 +231,7 @@ def binary_repr(num, width=None):
231231
Array must have the correct shape and the expected data type.
232232
233233
Default: ``None``.
234-
order : {"C", "F", "A", "K"}, optional
234+
order : {None, "C", "F", "A", "K"}, optional
235235
Memory layout of the newly output array, if parameter `out` is ``None``.
236236
237237
Default: ``"K"``.
@@ -292,7 +292,7 @@ def binary_repr(num, width=None):
292292
Array must have the correct shape and the expected data type.
293293
294294
Default: ``None``.
295-
order : {"C", "F", "A", "K"}, optional
295+
order : {None, "C", "F", "A", "K"}, optional
296296
Memory layout of the newly output array, if parameter `out` is ``None``.
297297
298298
Default: ``"K"``.
@@ -372,7 +372,7 @@ def binary_repr(num, width=None):
372372
Array must have the correct shape and the expected data type.
373373
374374
Default: ``None``.
375-
order : {"C", "F", "A", "K"}, optional
375+
order : {None, "C", "F", "A", "K"}, optional
376376
Memory layout of the newly output array, if parameter `out` is ``None``.
377377
378378
Default: ``"K"``.
@@ -450,7 +450,7 @@ def binary_repr(num, width=None):
450450
Array must have the correct shape and the expected data type.
451451
452452
Default: ``None``.
453-
order : {"C", "F", "A", "K"}, optional
453+
order : {None, "C", "F", "A", "K"}, optional
454454
Memory layout of the newly output array, if parameter `out` is ``None``.
455455
456456
Default: ``"K"``.
@@ -538,7 +538,7 @@ def binary_repr(num, width=None):
538538
Array must have the correct shape and the expected data type.
539539
540540
Default: ``None``.
541-
order : {"C", "F", "A", "K"}, optional
541+
order : {None, "C", "F", "A", "K"}, optional
542542
Memory layout of the newly output array, if parameter `out` is ``None``.
543543
544544
Default: ``"K"``.
@@ -617,7 +617,7 @@ def binary_repr(num, width=None):
617617
Array must have the correct shape and the expected data type.
618618
619619
Default: ``None``.
620-
order : {"C", "F", "A", "K"}, optional
620+
order : {None, "C", "F", "A", "K"}, optional
621621
Memory layout of the newly output array, if parameter `out` is ``None``.
622622
623623
Default: ``"K"``.

‎dpnp/dpnp_iface_linearalgebra.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -780,7 +780,7 @@ def matmul(
780780
Controls what kind of data casting may occur.
781781
782782
Default: ``"same_kind"``.
783-
order : {"C", "F", "A", "K", None}, optional
783+
order : {None, "C", "F", "A", "K"}, optional
784784
Memory layout of the newly output array, if parameter `out` is ``None``.
785785
786786
Default: ``"K"``.
@@ -960,7 +960,7 @@ def matvec(
960960
Controls what kind of data casting may occur.
961961
962962
Default: ``"same_kind"``.
963-
order : {"C", "F", "A", "K", None}, optional
963+
order : {None, "C", "F", "A", "K"}, optional
964964
Memory layout of the newly output array, if parameter `out` is ``None``.
965965
966966
Default: ``"K"``.
@@ -1335,7 +1335,7 @@ def vecdot(
13351335
Controls what kind of data casting may occur.
13361336
13371337
Default: ``"same_kind"``.
1338-
order : {"C", "F", "A", "K", None}, optional
1338+
order : {None, "C", "F", "A", "K"}, optional
13391339
Memory layout of the newly output array, if parameter `out` is ``None``.
13401340
13411341
Default: ``"K"``.
@@ -1463,7 +1463,7 @@ def vecmat(
14631463
Controls what kind of data casting may occur.
14641464
14651465
Default: ``"same_kind"``.
1466-
order : {"C", "F", "A", "K", None}, optional
1466+
order : {None, "C", "F", "A", "K"}, optional
14671467
Memory layout of the newly output array, if parameter `out` is ``None``.
14681468
14691469
Default: ``"K"``.

‎dpnp/dpnp_iface_logic.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -560,7 +560,7 @@ def array_equiv(a1, a2):
560560
Array have the correct shape and the expected data type.
561561
562562
Default: ``None``.
563-
order : {"C", "F", "A", "K"}, optional
563+
order : {None, "C", "F", "A", "K"}, optional
564564
Memory layout of the newly output array, if parameter `out` is ``None``.
565565
566566
Default: ``"K"``.
@@ -636,7 +636,7 @@ def array_equiv(a1, a2):
636636
Array must have the correct shape and the expected data type.
637637
638638
Default: ``None``.
639-
order : {"C", "F", "A", "K"}, optional
639+
order : {None, "C", "F", "A", "K"}, optional
640640
Memory layout of the newly output array, if parameter `out` is ``None``.
641641
642642
Default: ``"K"``.
@@ -706,7 +706,7 @@ def array_equiv(a1, a2):
706706
Array must have the correct shape and the expected data type.
707707
708708
Default: ``None``.
709-
order : {"C", "F", "A", "K"}, optional
709+
order : {None, "C", "F", "A", "K"}, optional
710710
Memory layout of the newly output array, if parameter `out` is ``None``.
711711
712712
Default: ``"K"``.
@@ -981,7 +981,7 @@ def iscomplexobj(x):
981981
Array must have the correct shape and the expected data type.
982982
983983
Default: ``None``.
984-
order : {"C", "F", "A", "K"}, optional
984+
order : {None, "C", "F", "A", "K"}, optional
985985
Memory layout of the newly output array, if parameter `out` is ``None``.
986986
987987
Default: ``"K"``.
@@ -1112,7 +1112,7 @@ def isfortran(a):
11121112
Array must have the correct shape and the expected data type.
11131113
11141114
Default: ``None``.
1115-
order : {"C", "F", "A", "K"}, optional
1115+
order : {None, "C", "F", "A", "K"}, optional
11161116
Memory layout of the newly output array, if parameter `out` is ``None``.
11171117
11181118
Default: ``"K"``.
@@ -1169,7 +1169,7 @@ def isfortran(a):
11691169
Array must have the correct shape and the expected data type.
11701170
11711171
Default: ``None``.
1172-
order : {"C", "F", "A", "K"}, optional
1172+
order : {None, "C", "F", "A", "K"}, optional
11731173
Memory layout of the newly output array, if parameter `out` is ``None``.
11741174
11751175
Default: ``"K"``.
@@ -1510,7 +1510,7 @@ def isscalar(element):
15101510
Array must have the correct shape and the expected data type.
15111511
15121512
Default: ``None``.
1513-
order : {"C", "F", "A", "K"}, optional
1513+
order : {None, "C", "F", "A", "K"}, optional
15141514
Memory layout of the newly output array, if parameter `out` is ``None``.
15151515
15161516
Default: ``"K"``.
@@ -1580,7 +1580,7 @@ def isscalar(element):
15801580
Array must have the correct shape and the expected data type.
15811581
15821582
Default: ``None``.
1583-
order : {"C", "F", "A", "K"}, optional
1583+
order : {None, "C", "F", "A", "K"}, optional
15841584
Memory layout of the newly output array, if parameter `out` is ``None``.
15851585
15861586
Default: ``"K"``.
@@ -1650,7 +1650,7 @@ def isscalar(element):
16501650
Array must have the correct shape and the expected data type.
16511651
16521652
Default: ``None``.
1653-
order : {"C", "F", "A", "K"}, optional
1653+
order : {None, "C", "F", "A", "K"}, optional
16541654
Memory layout of the newly output array, if parameter `out` is ``None``.
16551655
16561656
Default: ``"K"``.
@@ -1716,7 +1716,7 @@ def isscalar(element):
17161716
Array must have the correct shape and the expected data type.
17171717
17181718
Default: ``None``.
1719-
order : {"C", "F", "A", "K"}, optional
1719+
order : {None, "C", "F", "A", "K"}, optional
17201720
Memory layout of the newly output array, if parameter `out` is ``None``.
17211721
17221722
Default: ``"K"``.
@@ -1779,7 +1779,7 @@ def isscalar(element):
17791779
Array must have the correct shape and the expected data type.
17801780
17811781
Default: ``None``.
1782-
order : {"C", "F", "A", "K"}, optional
1782+
order : {None, "C", "F", "A", "K"}, optional
17831783
Memory layout of the newly output array, if parameter `out` is ``None``.
17841784
17851785
Default: ``"K"``.
@@ -1852,7 +1852,7 @@ def isscalar(element):
18521852
Array must have the correct shape and the expected data type.
18531853
18541854
Default: ``None``.
1855-
order : {"C", "F", "A", "K"}, optional
1855+
order : {None, "C", "F", "A", "K"}, optional
18561856
Memory layout of the newly output array, if parameter `out` is ``None``.
18571857
18581858
Default: ``"K"``.
@@ -1923,7 +1923,7 @@ def isscalar(element):
19231923
Array must have the correct shape and the expected data type.
19241924
19251925
Default: ``None``.
1926-
order : {"C", "F", "A", "K"}, optional
1926+
order : {None, "C", "F", "A", "K"}, optional
19271927
Memory layout of the newly output array, if parameter `out` is ``None``.
19281928
19291929
Default: ``"K"``.

0 commit comments

Comments
 (0)