]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-131094: Refine `math.isclose` docs (GH-131139) (#131393)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 18 Mar 2025 09:20:52 +0000 (10:20 +0100)
committerGitHub <noreply@github.com>
Tue, 18 Mar 2025 09:20:52 +0000 (09:20 +0000)
gh-131094: Refine `math.isclose` docs (GH-131139)
(cherry picked from commit 3f50f96586d46497e4d9de065c4424fe2d72508e)

Co-authored-by: Guy Jacoby <49398101+guyjacoby@users.noreply.github.com>
Doc/library/math.rst

index 0648293bfa7b899976aa45f549063174fea4fdea..1fb440ebb561c45b60447a82f4f8b9410e4a6d84 100644 (file)
@@ -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