From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Tue, 11 May 2021 18:19:42 +0000 (-0700) Subject: bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation (GH-23192... X-Git-Tag: v3.9.6~117 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bde14f7fbd5f11bb40d9c314bd74eaa231236c6b;p=thirdparty%2FPython%2Fcpython.git bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation (GH-23192) (#26036) (cherry picked from commit 12e7d10dfd28d4e26304e2c06b2e41c7418ec6f3) Co-authored-by: Irit Katriel --- diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index 2a42018b7bfc..894bbb11da91 100644 --- a/Doc/library/threading.rst +++ b/Doc/library/threading.rst @@ -110,10 +110,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 d96d99a713e9..4da5c657b1b7 100644 --- a/Lib/threading.py +++ b/Lib/threading.py @@ -1094,8 +1094,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"