Skip to content

Commit 16f940c

Browse files
github-actions[bot]github-actions[bot]
committed
Update docstrings for logic functions (#2368)
The PR updates docstrings for logic functions to have a blank line prior `Default` value. Additionally it proposes to align description of `order`, `out` `keepdims` keywords. 15b7644
1 parent 8132706 commit 16f940c

File tree

716 files changed

+2203
-2105
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

716 files changed

+2203
-2105
lines changed

‎.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 52267f1e8c15913a8170631f17c6884b
3+
config: eda50214b69a4ad81a8c34e75a3c1661
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎_modules/dpnp/dpnp_array.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.18.0dev0+29.g2956a29d383 documentation</title>
17+
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.18.0dev0+30.g15b7644d6d0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=d7375847"></script>
24+
<script src="../../_static/documentation_options.js?v=d71c1c7e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>
@@ -1054,7 +1054,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
10541054

10551055
<span class="sd"> Parameters</span>
10561056
<span class="sd"> ----------</span>
1057-
<span class="sd"> order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
1057+
<span class="sd"> order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
10581058
<span class="sd"> Memory layout of the newly output array.</span>
10591059
<span class="sd"> Default: ``&quot;C&quot;``.</span>
10601060
<span class="sd"> device : {None, string, SyclDevice, SyclQueue, Device}, optional</span>

‎_modules/dpnp/dpnp_array_api_info.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_array_api_info &mdash; Data Parallel Extension for NumPy 0.18.0dev0+29.g2956a29d383 documentation</title>
17+
<title>dpnp.dpnp_array_api_info &mdash; Data Parallel Extension for NumPy 0.18.0dev0+30.g15b7644d6d0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=d7375847"></script>
24+
<script src="../../_static/documentation_options.js?v=d71c1c7e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_flatiter.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.18.0dev0+29.g2956a29d383 documentation</title>
17+
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.18.0dev0+30.g15b7644d6d0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=d7375847"></script>
24+
<script src="../../_static/documentation_options.js?v=d71c1c7e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.18.0dev0+29.g2956a29d383 documentation</title>
17+
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.18.0dev0+30.g15b7644d6d0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=d7375847"></script>
24+
<script src="../../_static/documentation_options.js?v=d71c1c7e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>
@@ -663,7 +663,7 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
663663
<span class="sd"> ----------</span>
664664
<span class="sd"> a : {dpnp.ndarray, usm_ndarray}</span>
665665
<span class="sd"> Input array.</span>
666-
<span class="sd"> out : {dpnp.ndarray, usm_ndarray}</span>
666+
<span class="sd"> out : {None, dpnp.ndarray, usm_ndarray}</span>
667667
<span class="sd"> If provided, value of `a` array will be copied into it</span>
668668
<span class="sd"> according to ``safe`` casting rule.</span>
669669
<span class="sd"> It should be of the appropriate shape.</span>
@@ -676,7 +676,7 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
676676

677677
<span class="sd"> Returns</span>
678678
<span class="sd"> -------</span>
679-
<span class="sd"> out : {dpnp_array}</span>
679+
<span class="sd"> out : dpnp.ndarray</span>
680680
<span class="sd"> Return `out` if provided, otherwise return `a`.</span>
681681

682682
<span class="sd"> &quot;&quot;&quot;</span>

‎_modules/dpnp/dpnp_iface_arraycreation.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.18.0dev0+29.g2956a29d383 documentation</title>
17+
<title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.18.0dev0+30.g15b7644d6d0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=d7375847"></script>
24+
<script src="../../_static/documentation_options.js?v=d71c1c7e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>
@@ -410,7 +410,7 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
410410
<span class="sd"> (``dtype``, ``order``, etc.). For ``False`` it raises a ``ValueError``</span>
411411
<span class="sd"> exception if a copy can not be avoided.</span>
412412
<span class="sd"> Default: ``True``.</span>
413-
<span class="sd"> order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
413+
<span class="sd"> order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
414414
<span class="sd"> Memory layout of the newly output array.</span>
415415
<span class="sd"> Default: ``&quot;K&quot;``.</span>
416416
<span class="sd"> ndmin : int, optional</span>
@@ -1106,7 +1106,7 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
11061106
<span class="sd"> Input data, in any form that can be converted to an array. This</span>
11071107
<span class="sd"> includes scalars, lists, lists of tuples, tuples, tuples of tuples,</span>
11081108
<span class="sd"> tuples of lists, and ndarrays.</span>
1109-
<span class="sd"> order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
1109+
<span class="sd"> order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
11101110
<span class="sd"> Memory layout of the newly output array.</span>
11111111
<span class="sd"> Default: ``&quot;K&quot;``.</span>
11121112
<span class="sd"> device : {None, string, SyclDevice, SyclQueue, Device}, optional</span>
@@ -3733,7 +3733,7 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
37333733
<span class="sd"> precision, then the default integer precision is used. Otherwise, the</span>
37343734
<span class="sd"> precision is the same as that of `a`.</span>
37353735
<span class="sd"> Default: ``None``.</span>
3736-
<span class="sd"> out : {dpnp.ndarray, usm_ndarray}, optional</span>
3736+
<span class="sd"> out : {None, dpnp.ndarray, usm_ndarray}, optional</span>
37373737
<span class="sd"> Array into which the output is placed. Its type is preserved and it</span>
37383738
<span class="sd"> must be of the right shape to hold the output.</span>
37393739
<span class="sd"> Default: ``None``.</span>

‎_modules/dpnp/dpnp_iface_bitwise.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.18.0dev0+29.g2956a29d383 documentation</title>
17+
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.18.0dev0+30.g15b7644d6d0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=d7375847"></script>
24+
<script src="../../_static/documentation_options.js?v=d71c1c7e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>
@@ -238,7 +238,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
238238
<span class="s2"> Array must have the correct shape and the expected data type.</span>
239239

240240
<span class="s2"> Default: ``None``.</span>
241-
<span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
241+
<span class="s2">order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
242242
<span class="s2"> Memory layout of the newly output array, if parameter `out` is ``None``.</span>
243243

244244
<span class="s2"> Default: ``&quot;K&quot;``.</span>
@@ -319,7 +319,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
319319
<span class="s2"> Array must have the correct shape and the expected data type.</span>
320320

321321
<span class="s2"> Default: ``None``.</span>
322-
<span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
322+
<span class="s2">order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
323323
<span class="s2"> Memory layout of the newly output array, if parameter `out` is ``None``.</span>
324324

325325
<span class="s2"> Default: ``&quot;K&quot;``.</span>
@@ -380,7 +380,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
380380
<span class="s2"> Array must have the correct shape and the expected data type.</span>
381381

382382
<span class="s2"> Default: ``None``.</span>
383-
<span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
383+
<span class="s2">order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
384384
<span class="s2"> Memory layout of the newly output array, if parameter `out` is ``None``.</span>
385385

386386
<span class="s2"> Default: ``&quot;K&quot;``.</span>
@@ -460,7 +460,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
460460
<span class="s2"> Array must have the correct shape and the expected data type.</span>
461461

462462
<span class="s2"> Default: ``None``.</span>
463-
<span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
463+
<span class="s2">order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
464464
<span class="s2"> Memory layout of the newly output array, if parameter `out` is ``None``.</span>
465465

466466
<span class="s2"> Default: ``&quot;K&quot;``.</span>
@@ -538,7 +538,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
538538
<span class="s2"> Array must have the correct shape and the expected data type.</span>
539539

540540
<span class="s2"> Default: ``None``.</span>
541-
<span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
541+
<span class="s2">order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
542542
<span class="s2"> Memory layout of the newly output array, if parameter `out` is ``None``.</span>
543543

544544
<span class="s2"> Default: ``&quot;K&quot;``.</span>
@@ -626,7 +626,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
626626
<span class="s2"> Array must have the correct shape and the expected data type.</span>
627627

628628
<span class="s2"> Default: ``None``.</span>
629-
<span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
629+
<span class="s2">order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
630630
<span class="s2"> Memory layout of the newly output array, if parameter `out` is ``None``.</span>
631631

632632
<span class="s2"> Default: ``&quot;K&quot;``.</span>
@@ -705,7 +705,7 @@ <h1>Source code for dpnp.dpnp_iface_bitwise</h1><div class="highlight"><pre>
705705
<span class="s2"> Array must have the correct shape and the expected data type.</span>
706706

707707
<span class="s2"> Default: ``None``.</span>
708-
<span class="s2">order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
708+
<span class="s2">order : {None, &quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
709709
<span class="s2"> Memory layout of the newly output array, if parameter `out` is ``None``.</span>
710710

711711
<span class="s2"> Default: ``&quot;K&quot;``.</span>

‎_modules/dpnp/dpnp_iface_counting.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.18.0dev0+29.g2956a29d383 documentation</title>
17+
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.18.0dev0+30.g15b7644d6d0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=d7375847"></script>
24+
<script src="../../_static/documentation_options.js?v=d71c1c7e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface_functional.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_functional &mdash; Data Parallel Extension for NumPy 0.18.0dev0+29.g2956a29d383 documentation</title>
17+
<title>dpnp.dpnp_iface_functional &mdash; Data Parallel Extension for NumPy 0.18.0dev0+30.g15b7644d6d0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=d7375847"></script>
24+
<script src="../../_static/documentation_options.js?v=d71c1c7e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

‎_modules/dpnp/dpnp_iface_histograms.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_histograms &mdash; Data Parallel Extension for NumPy 0.18.0dev0+29.g2956a29d383 documentation</title>
17+
<title>dpnp.dpnp_iface_histograms &mdash; Data Parallel Extension for NumPy 0.18.0dev0+30.g15b7644d6d0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=d7375847"></script>
24+
<script src="../../_static/documentation_options.js?v=d71c1c7e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

0 commit comments

Comments
 (0)