Skip to content

gh-136563: Update concurrent.interpreters module documentation#139358

Open
aisk wants to merge 8 commits intopython:mainfrom
aisk:interpreters-doc
Open

gh-136563: Update concurrent.interpreters module documentation#139358
aisk wants to merge 8 commits intopython:mainfrom
aisk:interpreters-doc

Conversation

@aisk
Copy link
Copy Markdown
Member

@aisk aisk commented Sep 26, 2025

  • Removed the non-existent dedent parameter from Interpreter.exec().
  • Fixed exception class names for QueueEmpty/QueueFull.
  • Added missing parameter documentation for create_queue() including maxsize and unbounditems.
  • Documented the additional unbounditems parameter for Queue.put() and Queue.put_nowait().
  • Added missing documentation for the ItemInterpreterDestroyed exception class.

Update: removed the changes for _queues.py related documents because in the future we want to make the _queues.py module public and we should document them here.


📚 Documentation preview 📚: https://cpython-previews--139358.org.readthedocs.build/

Comment thread Doc/library/concurrent.interpreters.rst Outdated
Comment thread Doc/library/concurrent.interpreters.rst Outdated
Comment thread Doc/library/concurrent.interpreters.rst Outdated
Comment thread Doc/library/concurrent.interpreters.rst Outdated
aisk and others added 2 commits September 27, 2025 00:05
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
and return a :class:`Interpreter` object for it.

.. function:: create_queue()
.. function:: create_queue(maxsize=0)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this include the full signature? maxsize=0, *, unbounditems=UNBOUND

@github-actions
Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 30, 2026
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 stale Stale PR or inactive for long period of time.

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

4 participants