[New-bugs-announce] [issue42343] threading.local documentation should be on the net...

[Antti Haapala]

New submission from Antti Haapala <antti at haapala.name>:

The current documentation of `thread.local` is 


----
Thread-Local Data

Thread-local data is data whose values are thread specific. To manage thread-local data, just create an instance of local (or a subclass) and store attributes on it:

mydata = threading.local()
mydata.x = 1

The instance’s values will be different for separate threads.

class threading.local

    A class that represents thread-local data.

    For more details and extensive examples, see the documentation string of the _threading_local module.
----

There is no link to the `_threading_local` module docs in the documentation and none of the content from the modules docstrings appear  anywhere on docs.python.org website. This is rather annoying because the docstring contains completely non-trivial information including that threading.local can be subclassed and that the __init__ will be run once for each thread for each instance where attributes are accessed.

----------
assignee: docs at python
components: Documentation
messages: 380875
nosy: docs at python, ztane
priority: normal
severity: normal
status: open
title: threading.local documentation should be on the net...
type: enhancement

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue42343>
_______________________________________