Repository navigation
Conversation
- Add complete Queue method documentation (put, get, empty, full, qsize, maxsize, put_nowait, get_nowait) with parameter descriptions - Expand prepare_main docs explaining its purpose with an example - Fix exec() signature (remove incorrect dedent parameter) - Add detailed exec() and call() descriptions with error handling info - Expand call_in_thread docs explaining thread behavior - Document create_queue parameters (maxsize, unbounditems) - Add is_shareable() function documentation - Rewrite Basic usage section with clearer examples for exec, call, prepare_main, queues, and parallel execution patterns - Add tip pointing to InterpreterPoolExecutor for simpler use cases Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
All commit authors signed the Contributor License Agreement. |
UNBOUND, UNBOUND_ERROR, UNBOUND_REMOVE, and ItemInterpreterDestroyed are not in the module's public __all__, so use literal backticks instead of :data: and :exc: roles. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
This PR is stale because it has been open for 30 days with no activity. |
|
@ericsnowcurrently, could you please review this PR? |
github-actions
Bot
removed
the
stale
|
This PR is stale because it has been open for 90 days with no activity. |
…interpreters-docs # Conflicts: # Doc/library/concurrent.interpreters.rst
|
Merged main in be75cd2. gh-136563 had since documented the Queue methods and fixed the exec signature, so I kept main's version of those parts (QueueEmpty/QueueFull names, no unbounditems) and kept this PR's additions on top: is_shareable(), Queue.maxsize, fuller prepare_main/exec/call/call_in_thread text, and the extra examples. The NEWS entry now only describes what is left. sphinx-lint is clean on both files. |
Documentation build overview
|
Fixes #142041.
Improves the
concurrent.interpretersdocumentation with:put,get,empty,full,qsize,put_nowait,get_nowait,maxsize) with parameter descriptions including theunbounditemsbehaviorprepare_main: Expanded description explaining its purpose as the primary way to pass data to subinterpreters, with a usage exampleexec: Fixed incorrect signature (removed non-existentdedentparameter), added description of behavior, return value, error handling, and blocking semanticscallandcall_in_thread: Expanded descriptions covering supported callables, pickle fallback, error handling, and thread behaviorcreate_queue: Documentedmaxsizeandunbounditemsparametersis_shareable: Added missing function documentationexec/call,prepare_main, queue communication, and parallel execution patternsInterpreterPoolExecutorfor simpler use casesThis contribution was developed with AI assistance (Claude Code).
📚 Documentation preview 📚: https://cpython-previews--145657.org.readthedocs.build/