Skip to content

gh-149763: Improve availablity docs in select.rst#149764

Merged
sobolevn merged 6 commits into
python:mainfrom
sobolevn:issue-149763
May 15, 2026
Merged

gh-149763: Improve availablity docs in select.rst#149764
sobolevn merged 6 commits into
python:mainfrom
sobolevn:issue-149763

Conversation

@sobolevn
Copy link
Copy Markdown
Member

@sobolevn sobolevn commented May 13, 2026

Copy link
Copy Markdown
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Doc/tools/extensions/availability.py defines the allowed platforms.


Whilst we're editing this, please could you also update the headers to use sentence case?

"Edge and level trigger polling (epoll) objects" and so on.

https://devguide.python.org/documentation/style-guide/#capitalization


Also in this table: https://docs.python.org/3/library/select.html#edge-and-level-trigger-polling-epoll-objects

  • Change "assoc. fd" to "associated fd" or "associated file descriptor"
  • "polling on a fd" -> "polling on an fd" or "polling on a file descriptor"
  • Some of the Meaning column entries end with a full stop, some don't. Let's add them to all.

Elsewhere:

  • "process id" -> "process ID"
  • "Register a fd descriptor" -> "Register a file descriptor"
  • "Filter specific" -> "Filter-specific"
  • "User defined value" -> "User-defined value"

Comment thread Doc/library/select.rst Outdated
Comment thread Doc/library/select.rst Outdated
Comment thread Doc/library/select.rst Outdated
Comment thread Doc/library/select.rst Outdated
@sobolevn
Copy link
Copy Markdown
Member Author

@hugovk thanks a lot for an amazing review 🤝

@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 13, 2026

Documentation build overview

📚 cpython-previews | 🛠️ Build #32675761 | 📁 Comparing 2d5721d against main (6304eb1)

  🔍 Preview build  

2 files changed
± library/select.html
± whatsnew/changelog.html

@hugovk
Copy link
Copy Markdown
Member

hugovk commented May 13, 2026

Thanks! Please could you update the other headers:

/dev/poll Polling Objects
Polling Objects
Kqueue Objects
Kevent Objects

Comment thread Doc/library/select.rst Outdated
Comment thread Doc/library/select.rst
Comment thread Doc/library/select.rst Outdated
Copy link
Copy Markdown
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

One last thing:

"/dev/poll Polling objects" -> "/dev/poll polling objects"

Thanks!

@sobolevn sobolevn enabled auto-merge (squash) May 15, 2026 07:07
@sobolevn sobolevn 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 May 15, 2026
@sobolevn
Copy link
Copy Markdown
Member Author

Thanks everyone!

@sobolevn sobolevn merged commit 7e98deb into python:main May 15, 2026
35 of 36 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs May 15, 2026
@miss-islington-app
Copy link
Copy Markdown

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

@miss-islington-app
Copy link
Copy Markdown

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

cherry_picker 7e98debdf4bfcf1c3f592c9424bc654117c2723e 3.14

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 15, 2026

GH-149854 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 May 15, 2026
@miss-islington-app
Copy link
Copy Markdown

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

cherry_picker 7e98debdf4bfcf1c3f592c9424bc654117c2723e 3.13

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 15, 2026

GH-149855 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 May 15, 2026
sobolevn added a commit that referenced this pull request May 15, 2026
#149854)

gh-149763: Improve availablity docs in `select.rst` (GH-149764)
(cherry picked from commit 7e98deb)

Co-authored-by: sobolevn <mail@sobolevn.me>
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 15, 2026

GH-149856 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 May 15, 2026
sobolevn added a commit that referenced this pull request May 15, 2026
sobolevn added a commit that referenced this pull request May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants