gh-149763: Improve availablity docs in select.rst#149764
Conversation
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"
|
@hugovk thanks a lot for an amazing review 🤝 |
Documentation build overview
|
|
Thanks! Please could you update the other headers: /dev/poll Polling Objects |
hugovk
left a comment
There was a problem hiding this comment.
One last thing:
"/dev/poll Polling objects" -> "/dev/poll polling objects"
Thanks!
|
Thanks everyone! |
|
Thanks @sobolevn for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15. |
|
Sorry, @sobolevn, I could not cleanly backport this to |
|
GH-149854 is a backport of this pull request to the 3.15 branch. |
|
Sorry, @sobolevn, I could not cleanly backport this to |
|
GH-149855 is a backport of this pull request to the 3.14 branch. |
|
GH-149856 is a backport of this pull request to the 3.13 branch. |
select.rst#149763