diff options
author | Dieter Werthmüller <prisae@users.noreply.github.com> | 2019-04-26 08:02:42 +0200 |
---|---|---|
committer | Matti Picus <matti.picus@gmail.com> | 2019-04-25 23:02:42 -0700 |
commit | 5d248def4ebb0cbb96c4aebe0e2f17b9914119b1 (patch) | |
tree | 3182502b7f61e69c009f35ec338eb6fc9ba4b64d /numpy/testing/_private/utils.py | |
parent | f7783ec8df4a3c1473fe2c9611602d617559e7a2 (diff) | |
download | numpy-5d248def4ebb0cbb96c4aebe0e2f17b9914119b1.tar.gz |
DOC: defaults in allclose not the same as in assert_allclose (#13395)
* DOC: defaults in allclose not the same as in assert_allclose
Diffstat (limited to 'numpy/testing/_private/utils.py')
-rw-r--r-- | numpy/testing/_private/utils.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/numpy/testing/_private/utils.py b/numpy/testing/_private/utils.py index 24e26d65c..c22348103 100644 --- a/numpy/testing/_private/utils.py +++ b/numpy/testing/_private/utils.py @@ -1441,9 +1441,9 @@ def assert_allclose(actual, desired, rtol=1e-7, atol=0, equal_nan=True, Raises an AssertionError if two objects are not equal up to desired tolerance. - The test is equivalent to ``allclose(actual, desired, rtol, atol)``. - It compares the difference between `actual` and `desired` to - ``atol + rtol * abs(desired)``. + The test is equivalent to ``allclose(actual, desired, rtol, atol)`` (note + that ``allclose`` has different default values). It compares the difference + between `actual` and `desired` to ``atol + rtol * abs(desired)``. .. versionadded:: 1.5.0 |