Skip to content

gh-150232: Change Thread group parameter doc from 'should be' to 'must be'#150243

Closed
My-ABC wants to merge 3 commits into
python:mainfrom
My-ABC:fix-threading-group-doc
Closed

gh-150232: Change Thread group parameter doc from 'should be' to 'must be'#150243
My-ABC wants to merge 3 commits into
python:mainfrom
My-ABC:fix-threading-group-doc

Conversation

@My-ABC
Copy link
Copy Markdown
Contributor

@My-ABC My-ABC commented May 22, 2026

This PR updates the documentation for threading.Thread to accurately reflect the implementation.
The implementation uses assert group is None, which makes the parameter mandatory. The documentation is updated from "should be None" to "must be None".

Fixes #150232

@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 22, 2026

Documentation build overview

📚 cpython-previews | 🛠️ Build #32812020 | 📁 Comparing 49aa8c4 against main (cf5c8c5)

  🔍 Preview build  

1 file changed
± library/threading.html

@python-cla-bot
Copy link
Copy Markdown

python-cla-bot Bot commented May 22, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

Comment thread Doc/library/threading.rst
are:

*group* should be ``None``; reserved for future extension when a
*group* **must** be ``None``; reserved for future extension when a
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
*group* **must** be ``None``; reserved for future extension when a
*group* must be ``None`` as it is reserved for future extension when a

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review! I've applied the suggestion.

@My-ABC My-ABC closed this May 23, 2026
@My-ABC My-ABC deleted the fix-threading-group-doc branch May 23, 2026 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

threading.Thread: documentation says group "should be None", but implementation enforces it with AssertionError

2 participants