From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Tue, 18 Mar 2025 09:20:52 +0000 (+0100) Subject: [3.12] gh-131094: Refine `math.isclose` docs (GH-131139) (#131393) X-Git-Tag: v3.12.10~83 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c23a2d3bdc6e03e5f986d289a7d265392d1bcaaf;p=thirdparty%2FPython%2Fcpython.git [3.12] gh-131094: Refine `math.isclose` docs (GH-131139) (#131393) gh-131094: Refine `math.isclose` docs (GH-131139) (cherry picked from commit 3f50f96586d46497e4d9de065c4424fe2d72508e) Co-authored-by: Guy Jacoby <49398101+guyjacoby@users.noreply.github.com> --- diff --git a/Doc/library/math.rst b/Doc/library/math.rst index 0648293bfa7b..1fb440ebb561 100644 --- a/Doc/library/math.rst +++ b/Doc/library/math.rst @@ -155,8 +155,8 @@ Number-theoretic and representation functions *abs_tol* is the absolute tolerance; it defaults to ``0.0`` and it must be nonnegative. When comparing ``x`` to ``0.0``, ``isclose(x, 0)`` is computed - as ``abs(x) <= rel_tol * abs(x)``, which is ``False`` for any ``x`` and - rel_tol less than ``1.0``. So add an appropriate positive abs_tol argument + as ``abs(x) <= rel_tol * abs(x)``, which is ``False`` for any nonzero ``x`` and + *rel_tol* less than ``1.0``. So add an appropriate positive *abs_tol* argument to the call. The IEEE 754 special values of ``NaN``, ``inf``, and ``-inf`` will be