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 |
| +-------------------------+-----------------------------------------------+ | ||
| | :const:`EPOLLWAKEUP` | Prevents sleep during event waiting. | | ||
| +-------------------------+-----------------------------------------------+ | ||
| *eventmask* parameter can be one of the following: |
There was a problem hiding this comment.
| *eventmask* parameter can be one of the following: | |
| The *eventmask* is a bit mask using the following constants: |
They can be combined, no?
select.rst#149763