concurrent.interpreters queue documentation doesn't match reality
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
I don't know if this is a problem with the documentation or with reality but:
-
QueueEmptyErrorandQueueFullErrordon't exist (https://docs.python.org/3.14/library/concurrent.interpreters.html#concurrent.interpreters.QueueEmptyError). They appear to be calledQueueEmptyandQueueFull. -
queue.getdoesn't take a block keyword argument. The documentation sayswhich implements the queue.Queue interface.
and
queue.Queue.getis documented as having ablockmethod.
Linked PRs
- gh-139358
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the concurrent.interpreters documentation, especially the QueueEmptyError, QueueFullError, and queue.get references, and compare them with the reported names and signature. Check linked PR gh-139358 before making changes; done means the documentation matches the actual API behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 20/100