Skip to content

Commit 00279df

Browse files
Update docstrings in indexing functions (#2307)
The PR proposes to implement documentation improvements, including: - correct example in `dpnp.select` - updates docstrings for indexing functions to have a blank line prior `Default` value - align description of `dtype` keyword across all functions Note, updates in other files with adding blank line prior `Default` will be covered separately. a7dd8ba
1 parent 3bc483b commit 00279df

File tree

703 files changed

+1740
-1613
lines changed

Some content is hidden

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

703 files changed

+1740
-1613
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: b0cff5658b1752587e4303b2efd3652e
3+
config: b85e09b7bf84291c9bb240c75fbd37aa
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.17.0dev6+6.g898b6f295a5 documentation</title>
17+
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.17.0dev6+7.ga7dd8ba35f8 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=40d54c6a"></script>
24+
<script src="../../_static/documentation_options.js?v=a7f08746"></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>
@@ -901,7 +901,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
901901
<span class="sd"> ----------</span>
902902
<span class="sd"> x1 : {dpnp.ndarray, usm_ndarray}</span>
903903
<span class="sd"> Array data type casting.</span>
904-
<span class="sd"> dtype : dtype</span>
904+
<span class="sd"> dtype : {None, str, dtype object}</span>
905905
<span class="sd"> Target data type.</span>
906906
<span class="sd"> order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
907907
<span class="sd"> Row-major (C-style) or column-major (Fortran-style) order.</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.17.0dev6+6.g898b6f295a5 documentation</title>
17+
<title>dpnp.dpnp_array_api_info &mdash; Data Parallel Extension for NumPy 0.17.0dev6+7.ga7dd8ba35f8 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=40d54c6a"></script>
24+
<script src="../../_static/documentation_options.js?v=a7f08746"></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.17.0dev6+6.g898b6f295a5 documentation</title>
17+
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.17.0dev6+7.ga7dd8ba35f8 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=40d54c6a"></script>
24+
<script src="../../_static/documentation_options.js?v=a7f08746"></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.17.0dev6+6.g898b6f295a5 documentation</title>
17+
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.17.0dev6+7.ga7dd8ba35f8 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=40d54c6a"></script>
24+
<script src="../../_static/documentation_options.js?v=a7f08746"></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>
@@ -307,7 +307,7 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
307307
<span class="sd"> ----------</span>
308308
<span class="sd"> x1 : {dpnp.ndarray, usm_ndarray}</span>
309309
<span class="sd"> Array data type casting.</span>
310-
<span class="sd"> dtype : dtype</span>
310+
<span class="sd"> dtype : {None, str, dtype object}</span>
311311
<span class="sd"> Target data type.</span>
312312
<span class="sd"> order : {&#39;C&#39;, &#39;F&#39;, &#39;A&#39;, &#39;K&#39;}</span>
313313
<span class="sd"> Row-major (C-style) or column-major (Fortran-style) order.</span>
@@ -372,7 +372,7 @@ <h1>Source code for dpnp.dpnp_iface</h1><div class="highlight"><pre>
372372
<span class="sd"> ----------</span>
373373
<span class="sd"> a : {array_like, scalar}</span>
374374
<span class="sd"> Input array or scalar.</span>
375-
<span class="sd"> dtype : {None, dtype}, optional</span>
375+
<span class="sd"> dtype : {None, str, dtype object}, optional</span>
376376
<span class="sd"> The desired dtype for the result array if new array is creating. If not</span>
377377
<span class="sd"> given, a default dtype will be used that can represent the values (by</span>
378378
<span class="sd"> considering Promotion Type Rule and device capabilities when necessary).</span>

0 commit comments

Comments
 (0)