summaryrefslogtreecommitdiff
path: root/numpy/lib/scimath.py
diff options
context:
space:
mode:
authorMatthias Bussonnier <bussonniermatthias@gmail.com>2020-12-13 17:08:40 -0800
committerMatthias Bussonnier <bussonniermatthias@gmail.com>2020-12-18 20:49:36 -0800
commit09cbb7495b92a37ddfb5e7d1bc2e9964bc6a0609 (patch)
tree232e4a89b612a17fb9b373260dc5adb9306fb8de /numpy/lib/scimath.py
parentbac54ecb0b815eea2e8116d21aa96e1387793468 (diff)
downloadnumpy-09cbb7495b92a37ddfb5e7d1bc2e9964bc6a0609.tar.gz
DOC: Fix a couple of reference to verbatim and vice versa
This update a coupe of references (single backticks) that actually are not to verbatim/code (double backticks); and a couple of verbatim to reference when they do actually exists and can be resolved in context. I probably missed other; and stayed simple but spoted a few other inconsistencies that I did not fix: - some ``...`` could actually be :math:`...` but not always clear if it would be better. - some intervals are [``...``], other are ``[...]`` I guess they could be discussed individually; it was mostly the failing references that bothered me.
Diffstat (limited to 'numpy/lib/scimath.py')
-rw-r--r--numpy/lib/scimath.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/numpy/lib/scimath.py b/numpy/lib/scimath.py
index 2b0d38c37..ed9ffd295 100644
--- a/numpy/lib/scimath.py
+++ b/numpy/lib/scimath.py
@@ -572,10 +572,10 @@ def arctanh(x):
Compute the inverse hyperbolic tangent of `x`.
Return the "principal value" (for a description of this, see
- `numpy.arctanh`) of `arctanh(x)`. For real `x` such that
- `abs(x) < 1`, this is a real number. If `abs(x) > 1`, or if `x` is
+ `numpy.arctanh`) of ``arctanh(x)``. For real `x` such that
+ ``abs(x) < 1``, this is a real number. If `abs(x) > 1`, or if `x` is
complex, the result is complex. Finally, `x = 1` returns``inf`` and
- `x=-1` returns ``-inf``.
+ ``x=-1`` returns ``-inf``.
Parameters
----------
@@ -597,7 +597,7 @@ def arctanh(x):
-----
For an arctanh() that returns ``NAN`` when real `x` is not in the
interval ``(-1,1)``, use `numpy.arctanh` (this latter, however, does
- return +/-inf for `x = +/-1`).
+ return +/-inf for ``x = +/-1``).
Examples
--------