Skip to content

Move threading.local docs from docstring to the docs #107006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nedbat opened this issue Jul 22, 2023 · 2 comments
Closed

Move threading.local docs from docstring to the docs #107006

nedbat opened this issue Jul 22, 2023 · 2 comments
Labels
docs Documentation in the Doc dir

Comments

@nedbat
Copy link
Member

nedbat commented Jul 22, 2023

Documentation

https://docs.python.org/3/library/threading.html#threading.local says:

For more details and extensive examples, see the documentation string of the _threading_local module: Lib/_threading_local.py.

If we have good helpful words about a component in the standard library, we should publish them in the docs. The docstring should be moved to the .rst file, or at least parts harvested.

Linked PRs

@nedbat nedbat added the docs Documentation in the Doc dir label Jul 22, 2023
@mdickinson
Copy link
Member

Yes, please! It would be particularly useful to have the pattern of subclassing threading.local available in the docs.

lysnikolaou added a commit to lysnikolaou/cpython that referenced this issue Mar 28, 2025
hugovk added a commit that referenced this issue May 5, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this issue May 5, 2025
…31840)

(cherry picked from commit b97328e)

Co-authored-by: Lysandros Nikolaou <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
hugovk added a commit that referenced this issue May 5, 2025
#133432)

Co-authored-by: Lysandros Nikolaou <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@hugovk
Copy link
Member

hugovk commented May 5, 2025

Thanks all, this is now done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
Development

No branches or pull requests

3 participants