summaryrefslogtreecommitdiff
path: root/numpy/core/numeric.py
diff options
context:
space:
mode:
authorSpencer Hill <spencerahill@gmail.com>2017-09-19 21:31:06 -0700
committerSpencer Hill <spencerahill@gmail.com>2017-09-19 21:31:06 -0700
commit687d7b8675f8cbc216c822574eb5bcb92007b412 (patch)
treecd9972ad42bd15f0a43f8490f4925cb3ae0d49ec /numpy/core/numeric.py
parent08d60af925bb31e08259301a11b47b7d6f390ef2 (diff)
downloadnumpy-687d7b8675f8cbc216c822574eb5bcb92007b412.tar.gz
[ci skip] requested updates
[ci skip]
Diffstat (limited to 'numpy/core/numeric.py')
-rw-r--r--numpy/core/numeric.py13
1 files changed, 7 insertions, 6 deletions
diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py
index 4b78c16fd..e30df8b4e 100644
--- a/numpy/core/numeric.py
+++ b/numpy/core/numeric.py
@@ -2436,7 +2436,7 @@ def allclose(a, b, rtol=1.e-5, atol=1.e-8, equal_nan=False):
See Also
--------
- isclose, all, any, equals
+ isclose, all, any, equal
Notes
-----
@@ -2446,12 +2446,13 @@ def allclose(a, b, rtol=1.e-5, atol=1.e-8, equal_nan=False):
absolute(`a` - `b`) <= (`atol` + `rtol` * absolute(`b`))
The above equation is not symmetric in `a` and `b`, so that
- `allclose(a, b)` might be different from `allclose(b, a)` in
+ ``allclose(a, b)`` might be different from ``allclose(b, a)`` in
some rare cases.
-
- The comparison of `a` and `b` includes standard broadcasting,
- which means that `a` and `b` need not have the same shape in order for
- allclose(a, b) to evaluate to True. (The same is true for `equals`.)
+
+ The comparison of `a` and `b` uses standard broadcasting, which
+ means that `a` and `b` need not have the same shape in order for
+ ``allclose(a, b)`` to evaluate to True. The same is true for
+ ``equal`` but not ``array_equal``.
Examples
--------