Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Clarify thread.join() docs. #1873.

This commit is contained in:
Georg Brandl 2008-01-19 17:38:53 +00:00
parent 6c29be54a5
commit 6ebc52749c
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Doc/library/threading.rst
View File

@ -622,18 +622,19 @@ impossible to detect the termination of alien threads.
When the *timeout* argument is present and not ``None``, it should be a floating
point number specifying a timeout for the operation in seconds (or fractions
thereof). As :meth:`join` always returns ``None``, you must call
:meth:`isAlive` to decide whether a timeout happened.
thereof). As :meth:`join` always returns ``None``, you must call :meth:`isAlive`
after :meth:`join` to decide whether a timeout happened -- if the thread is
still alive, the :meth:`join` call timed out.
When the *timeout* argument is not present or ``None``, the operation will block
until the thread terminates.
A thread can be :meth:`join`\ ed many times.
:meth:`join` may throw a :exc:`RuntimeError`, if an attempt is made to join the
current thread as that would cause a deadlock. It is also an error to
:meth:`join` a thread before it has been started and attempts to do so raises
same exception.
:meth:`join` raises a :exc:`RuntimeError` if an attempt is made to join
the current thread as that would cause a deadlock. It is also an error to
:meth:`join` a thread before it has been started and attempts to do so
raises the same exception.
.. method:: Thread.getName()