summaryrefslogtreecommitdiffstats
path: root/Doc/library/threading.rst
diff options
context:
space:
mode:
authorIrit Katriel <iritkatriel@yahoo.com>2021-05-11 17:55:24 (GMT)
committerGitHub <noreply@github.com>2021-05-11 17:55:24 (GMT)
commit12e7d10dfd28d4e26304e2c06b2e41c7418ec6f3 (patch)
treee216cb66f21e588d4cf9c68d1bd5286e8964a369 /Doc/library/threading.rst
parentb05955d6f5f149523b5855a335444b7c6324bdb7 (diff)
downloadcpython-12e7d10dfd28d4e26304e2c06b2e41c7418ec6f3.zip
cpython-12e7d10dfd28d4e26304e2c06b2e41c7418ec6f3.tar.gz
cpython-12e7d10dfd28d4e26304e2c06b2e41c7418ec6f3.tar.bz2
bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation (#23192)
Diffstat (limited to 'Doc/library/threading.rst')
-rw-r--r--Doc/library/threading.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
index 16f23c3..8c76643 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()