Docs Are Not Clear on How to Share a Queue Between Interpreters
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
Users create cross-interpreter queues by calling concurrent.interpreters.create_queue(). @terryjreedy pointed out that the docs aren't clear about how to get a queue in one interpreter over to another interpreter. See https://github.com/python/cpython/issues/139383#issuecomment-3354723401.
The docs entry for concurrent.interpreters.create_queue() should call this case out specifically and include a short example code snippet. It would probably be smart to add something similar to the docs entry for Interpreter.prepare_main(); the original motivation for that method was to pass a queue to another interpreter.
Linked PRs
- gh-149367
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
Locate the documentation entries for concurrent.interpreters.create_queue() and Interpreter.prepare_main(), then review the linked discussion in issue 139383. Add a clear explanation and short example showing how a queue is passed between interpreters, with similar guidance for Interpreter.prepare_main(); done means both entries explicitly document this use case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100