python / python/cpython

Clarify `select.kqueue` and `select.kevent` also available on macOS

Open
#143,293 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs OS-mac
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

The document says kqueue() and kevent() are only supported on BSD, but macOS also fully supports them:

https://github.com/python/cpython/blob/7e3a5a7e791b742a74c64810f221854191b94c1f/Doc/library/select.rst?plain=1#L103
https://github.com/python/cpython/blob/7e3a5a7e791b742a74c64810f221854191b94c1f/Doc/library/select.rst?plain=1#L114

While macOS uses a userland from BSD (FreeBSD in these days I guess?), our documentation consistently treats macOS as a distinct platform from BSD, for example:

https://github.com/python/cpython/blob/7e3a5a7e791b742a74c64810f221854191b94c1f/Doc/library/socket.rst?plain=1#L651

Linked PRs
  • gh-143294

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in Doc/library/select.rst at the kqueue() and kevent() entries linked in the issue, then compare the platform wording with the socket.rst example. Done means the select documentation accurately identifies macOS support; linked PR gh-143294 shows that work is already underway.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.