Skip to content

gh-102740: Clarify time.monotonic() "system-wide" in the doc #136431

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

Jump to bottom
Merged
merged 2 commits into from
Jul 9, 2025
Merged

gh-102740: Clarify time.monotonic() "system-wide" in the doc #136431

merged 2 commits into from
Jul 9, 2025

Conversation

vstinner
Copy link
Member

@vstinner vstinner commented Jul 8, 2025 •
edited by github-actions bot
Loading

@vstinner vstinner requested review from abalkin and pganssle as code owners July 8, 2025 17:34
@vstinner vstinner added skip news needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jul 8, 2025
@bedevere-app bedevere-app bot added awaiting core review docs Documentation in the Doc dir labels Jul 8, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jul 8, 2025
Closed
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jul 8, 2025
StanFromIreland
StanFromIreland reviewed Jul 8, 2025
View reviewed changes
Copy link
Member

@StanFromIreland StanFromIreland left a comment •
edited
Loading

Choose a reason for hiding this comment

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

While this is great (for these two occurrences), I do not think this is the best way, since there are several (apart from the corrected two) cases:

cpython/Doc/library/time.rst

Line 328 in bc9bc07

does include time elapsed during sleep and is system-wide. The reference

cpython/Doc/library/time.rst

Line 343 in bc9bc07

On Windows, the function is now system-wide.

cpython/Doc/library/time.rst

Line 990 in bc9bc07

System-wide real-time clock. Setting this clock requires appropriate

It would be good to explain the term, maybe with the use of a glossary entry? This has the benefit of keeping the versionadded:: notes brief.

@vstinner
Copy link
Member Author

vstinner commented Jul 9, 2025

While this is great (for these two occurrences), I do not think this is the best way, since there are several (apart from the corrected two) cases

I completed my PR to update all occurrences.

StanFromIreland
StanFromIreland approved these changes Jul 9, 2025
View reviewed changes
Copy link
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

LGTM

Updating them all also works:-)

@vstinner vstinner merged commit 9c4d287 into python:main Jul 9, 2025
25 checks passed
@vstinner vstinner deleted the doc_monotonic branch July 9, 2025 23:06
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 9, 2025
@miss-islington-app
Copy link

Thanks @vstinner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 9, 2025
@vstinner @miss-islington
pythongh-102740: Clarify time.monotonic() "system-wide" in the doc (p…
3e875eb 
…ythonGH-136431)

(cherry picked from commit 9c4d287)

Co-authored-by: Victor Stinner <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Jul 9, 2025

GH-136488 is a backport of this pull request to the 3.14 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 9, 2025
@vstinner @miss-islington
pythongh-102740: Clarify time.monotonic() "system-wide" in the doc (p…
d09051c 
…ythonGH-136431)

(cherry picked from commit 9c4d287)

Co-authored-by: Victor Stinner <[email protected]>
@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 9, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 9, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 9, 2025
@vstinner
Copy link
Member Author

vstinner commented Jul 9, 2025

Merged, thanks for the reviews.

vstinner added a commit that referenced this pull request Jul 9, 2025
@miss-islington @vstinner
[3.14] gh-102740: Clarify time.monotonic() "system-wide" in the doc (G…
b733bf7 
…H-136431) (#136488)

gh-102740: Clarify time.monotonic() "system-wide" in the doc (GH-136431)
(cherry picked from commit 9c4d287)

Co-authored-by: Victor Stinner <[email protected]>
vstinner added a commit that referenced this pull request Jul 9, 2025
@miss-islington @vstinner
[3.13] gh-102740: Clarify time.monotonic() "system-wide" in the doc (G…
d223739 
…H-136431) (#136489)

gh-102740: Clarify time.monotonic() "system-wide" in the doc (GH-136431)
(cherry picked from commit 9c4d287)

Co-authored-by: Victor Stinner <[email protected]>
AndPuQing pushed a commit to AndPuQing/cpython that referenced this pull request Jul 11, 2025
@vstinner @AndPuQing
pythongh-102740: Clarify time.monotonic() "system-wide" in the doc (p…
391d651 
…ython#136431)
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
@vstinner @Pranjal095
pythongh-102740: Clarify time.monotonic() "system-wide" in the doc (p…
3a1e9b2 
…ython#136431)
picnixz pushed a commit to picnixz/cpython that referenced this pull request Jul 13, 2025
@vstinner @picnixz
pythongh-102740: Clarify time.monotonic() "system-wide" in the doc (p…
5684d41 
…ython#136431)
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
@vstinner @taegyunkim
pythongh-102740: Clarify time.monotonic() "system-wide" in the doc (p…
fd27eb2 
…ython#136431)
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@vstinner @Agent-Hellboy
pythongh-102740: Clarify time.monotonic() "system-wide" in the doc (p…
379a05e 
…ython#136431)
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
@miss-islington @vstinner @kumaraditya303
[3.14] pythongh-102740: Clarify time.monotonic() "system-wide" in the…
d34a9bc 
… doc (pythonGH-136431) (python#136488)

pythongh-102740: Clarify time.monotonic() "system-wide" in the doc (pythonGH-136431)
(cherry picked from commit 9c4d287)

Co-authored-by: Victor Stinner <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland approved these changes

@pganssle pganssle Awaiting requested review from pganssle pganssle is a code owner

@abalkin abalkin Awaiting requested review from abalkin abalkin is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@vstinner @StanFromIreland