summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatti Picus <matti.picus@gmail.com>2021-01-31 21:01:30 +0200
committerGitHub <noreply@github.com>2021-01-31 21:01:30 +0200
commitf55f5d45518c2f83271330041b982e55dcd6bbf9 (patch)
treeb794dae635c330f230d39547da5e918f3600746f
parentde8bb00dbf007b65095e858ff2490b8df39b9047 (diff)
parent71ac6b78a14206a8e3b8f5f7e55d0af8ef6b4bf5 (diff)
downloadnumpy-f55f5d45518c2f83271330041b982e55dcd6bbf9.tar.gz
Merge pull request #18269 from Carreau/more-doc-fixes
DOC: Nupydoc format space before `:` in Parameters
-rw-r--r--numpy/lib/nanfunctions.py2
-rw-r--r--numpy/random/_pickle.py6
-rw-r--r--tools/refguide_check.py12
3 files changed, 9 insertions, 11 deletions
diff --git a/numpy/lib/nanfunctions.py b/numpy/lib/nanfunctions.py
index 409016adb..a02ad779f 100644
--- a/numpy/lib/nanfunctions.py
+++ b/numpy/lib/nanfunctions.py
@@ -613,7 +613,7 @@ def nansum(a, axis=None, dtype=None, out=None, keepdims=np._NoValue):
--------
numpy.sum : Sum across array propagating NaNs.
isnan : Show which elements are NaN.
- isfinite: Show which elements are not NaN or +/-inf.
+ isfinite : Show which elements are not NaN or +/-inf.
Notes
-----
diff --git a/numpy/random/_pickle.py b/numpy/random/_pickle.py
index 29ff69644..71b01d6cd 100644
--- a/numpy/random/_pickle.py
+++ b/numpy/random/_pickle.py
@@ -19,7 +19,7 @@ def __generator_ctor(bit_generator_name='MT19937'):
Parameters
----------
- bit_generator_name: str
+ bit_generator_name : str
String containing the core BitGenerator
Returns
@@ -42,7 +42,7 @@ def __bit_generator_ctor(bit_generator_name='MT19937'):
Parameters
----------
- bit_generator_name: str
+ bit_generator_name : str
String containing the name of the BitGenerator
Returns
@@ -65,7 +65,7 @@ def __randomstate_ctor(bit_generator_name='MT19937'):
Parameters
----------
- bit_generator_name: str
+ bit_generator_name : str
String containing the core BitGenerator
Returns
diff --git a/tools/refguide_check.py b/tools/refguide_check.py
index ddcc1028d..9a6d1c9f8 100644
--- a/tools/refguide_check.py
+++ b/tools/refguide_check.py
@@ -166,9 +166,8 @@ def short_path(path, cwd=None):
Parameters
----------
- path: str or None
-
- cwd: str or None
+ path : str or None
+ cwd : str or None
Returns
-------
@@ -344,8 +343,8 @@ def is_deprecated(f):
"""
Check if module `f` is deprecated
- Parameter
- ---------
+ Parameters
+ ----------
f : ModuleType
Returns
@@ -785,8 +784,7 @@ def _run_doctests(tests, full_name, verbose, doctest_warnings):
full_name : str
verbose : bool
-
- doctest_warning : bool
+ doctest_warnings : bool
Returns
-------