diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2021-05-11 18:19:42 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-05-11 18:19:42 (GMT) |
commit | bde14f7fbd5f11bb40d9c314bd74eaa231236c6b (patch) | |
tree | c2190a212ff76792b6cd824a29aca6ca95d9e5ff /Doc/library/threading.rst | |
parent | 1d8c18019d25002fa8a4d548494ef49ce0209651 (diff) | |
download | cpython-bde14f7fbd5f11bb40d9c314bd74eaa231236c6b.zip cpython-bde14f7fbd5f11bb40d9c314bd74eaa231236c6b.tar.gz cpython-bde14f7fbd5f11bb40d9c314bd74eaa231236c6b.tar.bz2 |
bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation (GH-23192) (#26036)
(cherry picked from commit 12e7d10dfd28d4e26304e2c06b2e41c7418ec6f3)
Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
Diffstat (limited to 'Doc/library/threading.rst')
-rw-r--r-- | Doc/library/threading.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index 2a42018..894bbb1 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() |