diff options
| author |   Antoine Pitrou <solipsis@pitrou.net> | 2009-10-30 22:19:09 +0000 |
|---|---|---|
| committer | Antoine Pitrou <solipsis@pitrou.net> | 2009-10-30 22:19:09 +0000 |
| commit | 2c970a2ba23eb578923771922b0da2344385c137 (patch) | |
| tree | 7152b974d07d51540bb5052801eb661ee4892841 /Modules/threadmodule.c | |
| parent | Try to fix transient refleaks in test_pydoc. (diff) | |
| download | cpython-2c970a2ba23eb578923771922b0da2344385c137.tar.gz cpython-2c970a2ba23eb578923771922b0da2344385c137.tar.bz2 cpython-2c970a2ba23eb578923771922b0da2344385c137.zip | |
Remove official documentation entry for thread._count() and make the
docstring more descriptive instead.
Diffstat (limited to 'Modules/threadmodule.c')
| -rw-r--r-- | Modules/threadmodule.c | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/Modules/threadmodule.c b/Modules/threadmodule.c index c962c79f854..c682af22ef2 100644 --- a/Modules/threadmodule.c +++ b/Modules/threadmodule.c @@ -616,8 +616,14 @@ thread__count(PyObject *self) PyDoc_STRVAR(_count_doc, "_count() -> integer\n\ \n\ -Return the number of currently running (sub)threads.\n\ -This excludes the main thread."); +\ +Return the number of currently running Python threads, excluding \n\ +the main thread. The returned number comprises all threads created\n\ +through `start_new_thread()` as well as `threading.Thread`, and not\n\ +yet finished.\n\ +\n\ +This function is meant for internal and specialized purposes only.\n\ +In most applications `threading.enumerate()` should be used instead."); static PyObject * thread_stack_size(PyObject *self, PyObject *args) |