Skip to content

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

Open
sobolevn wants to merge 5 commits into
python:mainfrom
sobolevn:issue-149763
Open

gh-149763: Improve availablity docs in select.rst#149764
sobolevn wants to merge 5 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 Outdated
Comment thread Doc/library/select.rst Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting core review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

4 participants