aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorIrit Katriel <iritkatriel@yahoo.com>2021-05-11 18:55:24 +0100
committerGitHub <noreply@github.com>2021-05-11 18:55:24 +0100
commit12e7d10dfd28d4e26304e2c06b2e41c7418ec6f3 (patch)
treee216cb66f21e588d4cf9c68d1bd5286e8964a369
parentb05955d6f5f149523b5855a335444b7c6324bdb7 (diff)
downloadcpython-12e7d10dfd28d4e26304e2c06b2e41c7418ec6f3.tar.gz
cpython-12e7d10dfd28d4e26304e2c06b2e41c7418ec6f3.zip
bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation (#23192)
-rw-r--r--Doc/library/threading.rst9
-rw-r--r--Lib/threading.py4
2 files changed, 7 insertions, 6 deletions
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
index 16f23c3a0c3..8c7664328a4 100644
--- a/Doc/library/threading.rst
+++ b/Doc/library/threading.rst
@@ -121,10 +121,11 @@ This module defines the following functions:
.. function:: enumerate()
- Return a list of all :class:`Thread` objects currently alive. The list
- includes daemonic threads, dummy thread objects created by
- :func:`current_thread`, and the main thread. It excludes terminated threads
- and threads that have not yet been started.
+ Return a list of all :class:`Thread` objects currently active. The list
+ includes daemonic threads and dummy thread objects created by
+ :func:`current_thread`. It excludes terminated threads and threads
+ that have not yet been started. However, the main thread is always part
+ of the result, even when terminated.
.. function:: main_thread()
diff --git a/Lib/threading.py b/Lib/threading.py
index 4dcf84715c4..fb70abd17af 100644
--- a/Lib/threading.py
+++ b/Lib/threading.py
@@ -1130,8 +1130,8 @@ class Thread:
"""Return whether the thread is alive.
This method returns True just before the run() method starts until just
- after the run() method terminates. The module function enumerate()
- returns a list of all alive threads.
+ after the run() method terminates. See also the module function
+ enumerate().
"""
assert self._initialized, "Thread.__init__() not called"