summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authorMatti Picus <matti.picus@gmail.com>2021-03-02 15:49:37 +0200
committerGitHub <noreply@github.com>2021-03-02 15:49:37 +0200
commit6e2e9e678a44650d45f036d4a6c72609a3b8ab20 (patch)
tree2952baf0928b70c1984fd3d637a3201783320823 /numpy
parent0721406ede8b983b8689d8b70556499fc2aea28a (diff)
parent3867832a404f8eaaca0345c210d4f1d3a7b9d2bd (diff)
downloadnumpy-6e2e9e678a44650d45f036d4a6c72609a3b8ab20.tar.gz
Merge pull request #18509 from timhoffm/doc-link-fix
DOC: trunc, floor, ceil, rint, fix should all link to each other
Diffstat (limited to 'numpy')
-rw-r--r--numpy/core/code_generators/ufunc_docstrings.py15
-rw-r--r--numpy/lib/ufunclike.py2
2 files changed, 9 insertions, 8 deletions
diff --git a/numpy/core/code_generators/ufunc_docstrings.py b/numpy/core/code_generators/ufunc_docstrings.py
index 2f75cb41f..a9dbbf92e 100644
--- a/numpy/core/code_generators/ufunc_docstrings.py
+++ b/numpy/core/code_generators/ufunc_docstrings.py
@@ -781,7 +781,7 @@ add_newdoc('numpy.core.umath', 'ceil',
See Also
--------
- floor, trunc, rint
+ floor, trunc, rint, fix
Examples
--------
@@ -813,7 +813,7 @@ add_newdoc('numpy.core.umath', 'trunc',
See Also
--------
- ceil, floor, rint
+ ceil, floor, rint, fix
Notes
-----
@@ -1374,13 +1374,14 @@ add_newdoc('numpy.core.umath', 'floor',
See Also
--------
- ceil, trunc, rint
+ ceil, trunc, rint, fix
Notes
-----
- Some spreadsheet programs calculate the "floor-towards-zero", in other
- words ``floor(-2.5) == -2``. NumPy instead uses the definition of
- `floor` where `floor(-2.5) == -3`.
+ Some spreadsheet programs calculate the "floor-towards-zero", where
+ ``floor(-2.5) == -2``. NumPy instead uses the definition of
+ `floor` where `floor(-2.5) == -3`. The "floor-towards-zero"
+ function is called ``fix`` in NumPy.
Examples
--------
@@ -3486,7 +3487,7 @@ add_newdoc('numpy.core.umath', 'rint',
See Also
--------
- ceil, floor, trunc
+ fix, ceil, floor, trunc
Examples
--------
diff --git a/numpy/lib/ufunclike.py b/numpy/lib/ufunclike.py
index 0956de82b..a93c4773b 100644
--- a/numpy/lib/ufunclike.py
+++ b/numpy/lib/ufunclike.py
@@ -100,7 +100,7 @@ def fix(x, out=None):
See Also
--------
- trunc, floor, ceil
+ rint, trunc, floor, ceil
around : Round to given number of decimals
Examples