Skip to content

Fix various issues in the 'Timer File Descriptors' documentation - #156027

Merged
StanFromIreland merged 6 commits into
python:mainfrom
osandov:timerfd-settime-doc
Aug 25, 2026
Merged

Fix various issues in the 'Timer File Descriptors' documentation#156027
StanFromIreland merged 6 commits into
python:mainfrom
osandov:timerfd-settime-doc

Conversation

@osandov

@osandov osandov commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Document the correct default of 0 (based on the clinic input and os.timerfd_settime_ns()).

@osandov
Fix os.timerfd_settime() flags default argument doc typo
fb180da 
Document the correct default of 0 (based on the clinic input and
os.timerfd_settime_ns()).
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Aug 18, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Aug 18, 2026
@read-the-docs-community

read-the-docs-community Bot commented Aug 18, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34223994 | 📁 Comparing 2f0a97e against main (af49df9)

  🔍 Preview build  

25 files changed · + 1 added · ± 24 modified

+ Added

± Modified

@StanFromIreland StanFromIreland changed the title Fix os.timerfd_settime() flags default argument doc typo Fix various issues in the os.timerfd_settime{_ns}() documentation Aug 19, 2026
@StanFromIreland StanFromIreland changed the title Fix various issues in the os.timerfd_settime{_ns}() documentation Fix various issues in the 'Timer File Descriptors' documentation Aug 19, 2026
@StanFromIreland

StanFromIreland commented Aug 19, 2026

Copy link
Copy Markdown
Member

I fixed a few additional issues, @vstinner can you please take a look?

@osandov
Fix return tuple order in os.timerfd_gettime*() docstring
5edac05 
The reST docs have it right, but it's backwards in the docstring.
@osandov

osandov commented Aug 19, 2026

Copy link
Copy Markdown
Contributor Author

I found and fixed one more issue.

StanFromIreland
StanFromIreland approved these changes Aug 19, 2026
View reviewed changes

@StanFromIreland StanFromIreland 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.

LGTM

@StanFromIreland StanFromIreland added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Aug 25, 2026
@StanFromIreland
StanFromIreland merged commit 13ab4c2 into python:main Aug 25, 2026
54 checks passed
@miss-islington-app

miss-islington-app Bot commented Aug 25, 2026

Copy link
Copy Markdown

Thanks @osandov for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Aug 25, 2026
@miss-islington-app

miss-islington-app Bot commented Aug 25, 2026

Copy link
Copy Markdown

Sorry, @osandov and @StanFromIreland, I could not cleanly backport this to 3.15 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 13ab4c2861442f3c558abdb5971716261bf15964 3.15

@miss-islington-app

miss-islington-app Bot commented Aug 25, 2026

Copy link
Copy Markdown

Sorry, @osandov and @StanFromIreland, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 13ab4c2861442f3c558abdb5971716261bf15964 3.14

@miss-islington-app

miss-islington-app Bot commented Aug 25, 2026

Copy link
Copy Markdown

Sorry, @osandov and @StanFromIreland, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 13ab4c2861442f3c558abdb5971716261bf15964 3.13

@StanFromIreland

StanFromIreland commented Aug 25, 2026

Copy link
Copy Markdown
Member

Merged, thanks!

@osandov would you be able to do the backports? See the devguide for some instructions.

@bedevere-app

bedevere-app Bot commented Aug 27, 2026

Copy link
Copy Markdown

GH-156479 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Aug 27, 2026
@bedevere-app

bedevere-app Bot commented Aug 27, 2026

Copy link
Copy Markdown

GH-156480 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 Aug 27, 2026
@bedevere-app

bedevere-app Bot commented Aug 27, 2026

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Aug 27, 2026
StanFromIreland added a commit that referenced this pull request Aug 27, 2026
@StanFromIreland @osandov
[3.13] Fix various issues in the 'Timer File Descriptors' documentati…
c6d191d 
…on (GH-156027) (#156480)

(cherry picked from commit 13ab4c2)

Co-authored-by: Omar Sandoval <osandov@osandov.com>
StanFromIreland added a commit that referenced this pull request Aug 27, 2026
@StanFromIreland @osandov
[3.14] Fix various issues in the 'Timer File Descriptors' documentati…
0bf3b71 
…on (GH-156027) (#156481)

(cherry picked from commit 13ab4c2)

Co-authored-by: Omar Sandoval <osandov@osandov.com>
clin1234 pushed a commit to clin1234/cpython that referenced this pull request Aug 27, 2026
@osandov @StanFromIreland @clin1234
Fix various issues in the 'Timer File Descriptors' documentation (pyt…
091f338 
…hon#156027)

Co-authored-by: Stan Ulbrych <stan@python.org>
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
@vstinner vstinner Awaiting requested review from vstinner

Assignees

@StanFromIreland StanFromIreland

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@osandov @StanFromIreland