gh-126165: Improve docs of function math.isclose
#126215
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ython into fix-isclose-docs
bedevere-app
bot
added
docs
skirpichev
reviewed
Oct 31, 2024
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
skirpichev
reviewed
Oct 31, 2024
skirpichev
previously approved these changes
Oct 31, 2024
|
CC @terryjreedy |
picnixz
reviewed
Oct 31, 2024
willingc
reviewed
Nov 2, 2024
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
willingc
approved these changes
Nov 2, 2024
willingc
approved these changes
Nov 2, 2024
terryjreedy
requested changes
Nov 3, 2024
There was a problem hiding this comment.
I would like 3 changes.
- move the result sentence "If no errors occur, ... abs_tol)``." to immediately after the second sentence "Whether ... is determined ... [by] tolerances." The result sentence specifies how the tolerances determine, which is needed to really understand the entries that follow.
- At the end of the rel_tol entry, either replace "greater than zero" with "nonnegative" or prefix it with "equal or ". Either way, add "and less than one" at the end. The meaning of the function assumes much less than one.
- Further revise the abs_tol entry as suggested below in my comment.
|
@terryjreedy, I have made the requested changes; please review again. |
|
Thanks for making the requested changes! @willingc, @terryjreedy: please review the changes made to this pull request. |
terryjreedy
approved these changes
Nov 3, 2024
willingc
approved these changes
Nov 3, 2024
There was a problem hiding this comment.
Great improvements over the original. Thanks @terryjreedy for the additional content.
terryjreedy
added
needs backport to 3.12
|
Thanks @Xiaokang2022 for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 4, 2024
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 4, 2024
|
GH-126380 is a backport of this pull request to the 3.13 branch. |
|
GH-126381 is a backport of this pull request to the 3.12 branch. |
terryjreedy
added a commit
that referenced
this pull request
Nov 4, 2024
…#126380) gh-126165: Improve docs of function `math.isclose` (GH-126215) (cherry picked from commit 081706f) Co-authored-by: Zhikang Yan <2951256653@qq.com> Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
terryjreedy
added a commit
that referenced
this pull request
Nov 4, 2024
…#126381) gh-126165: Improve docs of function `math.isclose` (GH-126215) (cherry picked from commit 081706f) Co-authored-by: Zhikang Yan <2951256653@qq.com> Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
picnixz
pushed a commit
to picnixz/cpython
that referenced
this pull request
Dec 8, 2024
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
ebonnal
pushed a commit
to ebonnal/cpython
that referenced
this pull request
Jan 12, 2025
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
math.isclosecan be somewhat misleading #126165📚 Documentation preview 📚: https://cpython-previews--126215.org.readthedocs.build/