mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-09 18:48:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation (#23192)

Browse source
This commit is contained in:
Irit Katriel 2021-05-11 18:55:24 +01:00 • committed by GitHub
parent b05955d6f5
commit 12e7d10dfd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/threading.rst
View file

@ -121,10 +121,11 @@ This module defines the following functions:
.. function:: enumerate() .. function:: enumerate()
Return a list of all :class:`Thread` objects currently alive. The list Return a list of all :class:`Thread` objects currently active. The list
includes daemonic threads, dummy thread objects created by includes daemonic threads and dummy thread objects created by
:func:`current_thread`, and the main thread. It excludes terminated threads :func:`current_thread`. It excludes terminated threads and threads
and threads that have not yet been started. that have not yet been started. However, the main thread is always part
of the result, even when terminated.
.. function:: main_thread() .. function:: main_thread()

4
Lib/threading.py
View file

@ -1130,8 +1130,8 @@ class Thread:
"""Return whether the thread is alive. """Return whether the thread is alive.
This method returns True just before the run() method starts until just This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate() after the run() method terminates. See also the module function
returns a list of all alive threads. enumerate().
""" """
assert self._initialized, "Thread.__init__() not called" assert self._initialized, "Thread.__init__() not called"