Skip to content

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

Merged
terryjreedy merged 15 commits into
python:mainfrom
Xiaokang2022:fix-isclose-docs
Nov 4, 2024
Merged

gh-126165: Improve docs of function math.isclose#126215
terryjreedy merged 15 commits into
python:mainfrom
Xiaokang2022:fix-isclose-docs

Conversation

@Xiaokang2022

@Xiaokang2022Xiaokang2022 commented Oct 31, 2024•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

@bedevere-appbedevere-appBot added docs Documentation in the Doc dir skip news awaiting review labels Oct 31, 2024
@bedevere-appbedevere-appBot mentioned this pull request Oct 31, 2024
Closed
@rruuaanng

rruuaanng commented Oct 31, 2024

Copy link
Copy Markdown
Contributor

@skirpichev

skirpichev
skirpichev reviewed Oct 31, 2024
View reviewed changes
Comment threadDoc/library/math.rst Outdated
Xiaokang2022and others added 3 commits October 31, 2024 13:04
@Xiaokang2022@skirpichev
Update Doc/library/math.rst
f6199e6
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
@Xiaokang2022
Improve docs
6d0cf74
@Xiaokang2022
Improve docs
c620230
skirpichev
skirpichev reviewed Oct 31, 2024
View reviewed changes
Comment threadDoc/library/math.rst Outdated
skirpichev
skirpichev previously approved these changes Oct 31, 2024
View reviewed changes
@skirpichev

skirpichev commented Oct 31, 2024

Copy link
Copy Markdown
Member

CC @terryjreedy

picnixz
picnixz reviewed Oct 31, 2024
View reviewed changes
Comment threadDoc/library/cmath.rst Outdated
Comment threadDoc/library/math.rst Outdated
willingc
willingc reviewed Nov 2, 2024
View reviewed changes
Comment threadDoc/library/cmath.rst Outdated
Xiaokang2022and others added 2 commits November 3, 2024 00:59
@Xiaokang2022@willingc
Update Doc/library/cmath.rst
c2e6c59
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
@Xiaokang2022
Improve docs
8cc872f
willingc
willingc approved these changes Nov 2, 2024
View reviewed changes

@willingcwillingc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Xiaokang2022 for the PR and folks for reviews.

terryjreedy
terryjreedy requested changes Nov 3, 2024
View reviewed changes

@terryjreedyterryjreedy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like 3 changes.

  1. 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.
  2. 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.
  3. Further revise the abs_tol entry as suggested below in my comment.

Comment threadDoc/library/cmath.rst Outdated
@Xiaokang2022

Xiaokang2022 commented Nov 3, 2024

Copy link
Copy Markdown
ContributorAuthor

@terryjreedy, I have made the requested changes; please review again.

@bedevere-app

bedevere-appBot commented Nov 3, 2024

Copy link
Copy Markdown

Thanks for making the requested changes!

@willingc, @terryjreedy: please review the changes made to this pull request.

@terryjreedyterryjreedy self-assigned this Nov 3, 2024
willingc
willingc approved these changes Nov 3, 2024
View reviewed changes

@willingcwillingc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great improvements over the original. Thanks @terryjreedy for the additional content.

@terryjreedyterryjreedy added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Nov 4, 2024
@terryjreedy
terryjreedy merged commit 081706f into python:mainNov 4, 2024
@miss-islington-app

miss-islington-appBot commented Nov 4, 2024

Copy link
Copy Markdown

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
@Xiaokang2022@skirpichev
@willingc@terryjreedy@miss-islington
pythongh-126165: Improve docs of functionmath.isclose(pythonGH-12…
a99b9bf
…6215)
(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>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 4, 2024
@Xiaokang2022@skirpichev
@willingc@terryjreedy@miss-islington
pythongh-126165: Improve docs of functionmath.isclose(pythonGH-12…
20b17c2
…6215)
(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>
@bedevere-app

bedevere-appBot commented Nov 4, 2024

Copy link
Copy Markdown

GH-126380 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label Nov 4, 2024
@bedevere-app

bedevere-appBot commented Nov 4, 2024

Copy link
Copy Markdown

GH-126381 is a backport of this pull request to the 3.12 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.12 only security fixes label Nov 4, 2024
terryjreedy added a commit that referenced this pull request Nov 4, 2024
@miss-islington@Xiaokang2022
@skirpichev@willingc@terryjreedy
[3.13]gh-126165: Improve docs of functionmath.isclose(GH-126215) (…
d89d78b
…#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
@miss-islington@Xiaokang2022
@skirpichev@willingc@terryjreedy
[3.12]gh-126165: Improve docs of functionmath.isclose(GH-126215) (…
d1b8718
…#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>
@skirpichevskirpichev mentioned this pull request Nov 18, 2024
Merged
picnixz pushed a commit to picnixz/cpython that referenced this pull request Dec 8, 2024
@Xiaokang2022@skirpichev
@willingc@terryjreedy@picnixz
pythongh-126165: Improve docs of functionmath.isclose(python#126215)
b7eac47
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>
@Xiaokang2022
Xiaokang2022 deleted the fix-isclose-docs branch January 6, 2025 04:40
ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025
@Xiaokang2022@skirpichev
@willingc@terryjreedy@ebonnal
pythongh-126165: Improve docs of functionmath.isclose(python#126215)
96d451a
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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@skirpichevskirpichevskirpichev left review comments
@picnixzpicnixzpicnixz left review comments
@terryjreedyterryjreedyterryjreedy approved these changes
@willingcwillingcwillingc approved these changes

Assignees

@terryjreedyterryjreedy

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Xiaokang2022@rruuaanng@skirpichev@willingc@picnixz@terryjreedy