Skip to content

gh-126165: Improve docs of function math.isclose #126215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
terryjreedy merged 15 commits into from
Nov 4, 2024
Merged

gh-126165: Improve docs of function math.isclose #126215

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
683a59a
Improve docs
Xiaokang2022 Oct 31, 2024
5f2c43b
Merge branch 'fix-isclose-docs' of https://github.com/Xiaokang2022/cp…
Xiaokang2022 Oct 31, 2024
993b72d
Improve docs
Xiaokang2022 Oct 31, 2024
f6199e6
Update Doc/library/math.rst
Xiaokang2022 Oct 31, 2024
6d0cf74
Improve docs
Xiaokang2022 Oct 31, 2024
c620230
Improve docs
Xiaokang2022 Oct 31, 2024
f405fcf
Improve docs
Xiaokang2022 Oct 31, 2024
730b040
Improve docs
Xiaokang2022 Oct 31, 2024
c2e6c59
Update Doc/library/cmath.rst
Xiaokang2022 Nov 2, 2024
8cc872f
Improve docs
Xiaokang2022 Nov 2, 2024
9cd0d83
Improve docs
Xiaokang2022 Nov 2, 2024
b9f37e8
Update Doc/library/cmath.rst
Xiaokang2022 Nov 3, 2024
90baab0
style
Xiaokang2022 Nov 3, 2024
c9a83b3
style
Xiaokang2022 Nov 3, 2024
e8e2a0c
Improve docs
Xiaokang2022 Nov 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Improve docs
  • Loading branch information
@Xiaokang2022
Xiaokang2022 committed Oct 31, 2024
commit c62023071757191867fa99211b9e91790aec693c
6 changes: 3 additions & 3 deletions Doc/library/cmath.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,9 @@ Classification functions
within about 9 decimal digits. *rel_tol* must be a nonnegative value.

*abs_tol* is the absolute tolerance; it must be at least ``0.0``.
Comment thread
terryjreedy marked this conversation as resolved.
Outdated
When comparing to ``0.0``, the default *abs_tol* of ``0.0`` means that only
``0.0`` is close to ``0.0``. Pass a larger tolerance to allow for floating
point inaccuracies.
When comparing to ``0.0``, the default tolerance values means that only
Comment thread
terryjreedy marked this conversation as resolved.
Outdated
``0.0`` is close to ``0.0``. Pass an appropriate absolute tolerance to
compare with ``0.0``.

If no errors occur, the result will be:
``abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol)``.
Expand Down