gh-149763: Improve availablity docs in select.rst#149764
Open
sobolevn wants to merge 5 commits into
Open
Conversation
hugovk
reviewed
May 13, 2026
Member
hugovk
left a comment
There was a problem hiding this comment.
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"
Member
Author
|
@hugovk thanks a lot for an amazing review 🤝 |
Documentation build overview
|
Member
|
Thanks! Please could you update the other headers: /dev/poll Polling Objects |
This file contains hidden or 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
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.
select.rst#149763