summaryrefslogtreecommitdiff
path: root/doc/source/reference/routines.testing.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/reference/routines.testing.rst')
-rw-r--r--doc/source/reference/routines.testing.rst16
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/source/reference/routines.testing.rst b/doc/source/reference/routines.testing.rst
index 98ce3f377..d9e98e941 100644
--- a/doc/source/reference/routines.testing.rst
+++ b/doc/source/reference/routines.testing.rst
@@ -18,9 +18,6 @@ Asserts
.. autosummary::
:toctree: generated/
- assert_almost_equal
- assert_approx_equal
- assert_array_almost_equal
assert_allclose
assert_array_almost_equal_nulp
assert_array_max_ulp
@@ -32,6 +29,19 @@ Asserts
assert_warns
assert_string_equal
+Asserts (not recommended)
+-------------------------
+It is recommended to use one of `assert_allclose`,
+`assert_array_almost_equal_nulp` or `assert_array_max_ulp` instead of these
+functions for more consistent floating point comparisons.
+
+.. autosummary::
+ :toctree: generated/
+
+ assert_almost_equal
+ assert_approx_equal
+ assert_array_almost_equal
+
Decorators
----------
.. autosummary::