Skip to content

Commit 15ae54e

Browse files
Update docstrings for dpnp.scipy.linalg LU functions (#2802)
This PR implements few improvements for LU function in `dpnp.scipy.linalg` namespace: * resolved issue with `Returns` section formatting in `lu` function * changed to proper `func:` role for the functions cross-references in `See also` section * used `Warnings` section name instead of `Warning` * changed `{None, bool}` to `bool` for overwrite_a, check_finite, and overwrite_b parameters 4b64466
1 parent 96d3680 commit 15ae54e

File tree

760 files changed

+1584
-1588
lines changed

Some content is hidden

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

760 files changed

+1584
-1588
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: 1bb8931e93688929e20ef38889ea6563
3+
config: 86bc9511ced0ba930038cb102340088b
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/dpnp/dpnp_array.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 &mdash; Data Parallel Extension for NumPy 0.20.0dev3+11.ga2825a1f629 documentation</title>
17+
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.20.0dev3+12.g4b644661997 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=9edc463e" />
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=9aba200e"></script>
24+
<script src="../../_static/documentation_options.js?v=24395671"></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_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.20.0dev3+11.ga2825a1f629 documentation</title>
17+
<title>dpnp.dpnp_array_api_info &mdash; Data Parallel Extension for NumPy 0.20.0dev3+12.g4b644661997 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=9edc463e" />
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=9aba200e"></script>
24+
<script src="../../_static/documentation_options.js?v=24395671"></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.20.0dev3+11.ga2825a1f629 documentation</title>
17+
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.20.0dev3+12.g4b644661997 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=9edc463e" />
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=9aba200e"></script>
24+
<script src="../../_static/documentation_options.js?v=24395671"></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: 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 &mdash; Data Parallel Extension for NumPy 0.20.0dev3+11.ga2825a1f629 documentation</title>
17+
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.20.0dev3+12.g4b644661997 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=9edc463e" />
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=9aba200e"></script>
24+
<script src="../../_static/documentation_options.js?v=24395671"></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_arraycreation.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_arraycreation &mdash; Data Parallel Extension for NumPy 0.20.0dev3+11.ga2825a1f629 documentation</title>
17+
<title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.20.0dev3+12.g4b644661997 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=9edc463e" />
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=9aba200e"></script>
24+
<script src="../../_static/documentation_options.js?v=24395671"></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_bitwise.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_bitwise &mdash; Data Parallel Extension for NumPy 0.20.0dev3+11.ga2825a1f629 documentation</title>
17+
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.20.0dev3+12.g4b644661997 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=9edc463e" />
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=9aba200e"></script>
24+
<script src="../../_static/documentation_options.js?v=24395671"></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_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.20.0dev3+11.ga2825a1f629 documentation</title>
17+
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.20.0dev3+12.g4b644661997 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=9edc463e" />
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=9aba200e"></script>
24+
<script src="../../_static/documentation_options.js?v=24395671"></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.20.0dev3+11.ga2825a1f629 documentation</title>
17+
<title>dpnp.dpnp_iface_functional &mdash; Data Parallel Extension for NumPy 0.20.0dev3+12.g4b644661997 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=9edc463e" />
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=9aba200e"></script>
24+
<script src="../../_static/documentation_options.js?v=24395671"></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: 12 additions & 12 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.20.0dev3+11.ga2825a1f629 documentation</title>
17+
<title>dpnp.dpnp_iface_histograms &mdash; Data Parallel Extension for NumPy 0.20.0dev3+12.g4b644661997 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=9edc463e" />
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=9aba200e"></script>
24+
<script src="../../_static/documentation_options.js?v=24395671"></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>
@@ -393,8 +393,8 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
393393

394394
<span class="sd"> For full documentation refer to :obj:`numpy.bincount`.</span>
395395

396-
<span class="sd"> Warning</span>
397-
<span class="sd"> -------</span>
396+
<span class="sd"> Warnings</span>
397+
<span class="sd"> --------</span>
398398
<span class="sd"> This function synchronizes in order to calculate binning edges.</span>
399399
<span class="sd"> This may harm performance in some applications.</span>
400400

@@ -597,8 +597,8 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
597597

598598
<span class="sd"> For full documentation refer to :obj:`numpy.histogram`.</span>
599599

600-
<span class="sd"> Warning</span>
601-
<span class="sd"> -------</span>
600+
<span class="sd"> Warnings</span>
601+
<span class="sd"> --------</span>
602602
<span class="sd"> This function may synchronize in order to check a monotonically increasing</span>
603603
<span class="sd"> array of bin edges. This may harm performance in some applications.</span>
604604

@@ -771,8 +771,8 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
771771

772772
<span class="sd"> For full documentation refer to :obj:`numpy.histogram_bin_edges`.</span>
773773

774-
<span class="sd"> Warning</span>
775-
<span class="sd"> -------</span>
774+
<span class="sd"> Warnings</span>
775+
<span class="sd"> --------</span>
776776
<span class="sd"> This function may synchronize in order to check a monotonically increasing</span>
777777
<span class="sd"> array of bin edges. This may harm performance in some applications.</span>
778778

@@ -866,8 +866,8 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
866866

867867
<span class="sd"> For full documentation refer to :obj:`numpy.histogram2d`.</span>
868868

869-
<span class="sd"> Warning</span>
870-
<span class="sd"> -------</span>
869+
<span class="sd"> Warnings</span>
870+
<span class="sd"> --------</span>
871871
<span class="sd"> This function may synchronize in order to check a monotonically increasing</span>
872872
<span class="sd"> array of bin edges. This may harm performance in some applications.</span>
873873

@@ -1202,8 +1202,8 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
12021202

12031203
<span class="sd"> For full documentation refer to :obj:`numpy.histogramdd`.</span>
12041204

1205-
<span class="sd"> Warning</span>
1206-
<span class="sd"> -------</span>
1205+
<span class="sd"> Warnings</span>
1206+
<span class="sd"> --------</span>
12071207
<span class="sd"> This function may synchronize in order to check a monotonically increasing</span>
12081208
<span class="sd"> array of bin edges. This may harm performance in some applications.</span>
12091209

0 commit comments

Comments
 (0)