summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2005-07-17 21:00:26 (GMT)
committerGeorg Brandl <georg@python.org>2005-07-17 21:00:26 (GMT)
commit75d5106bd0e026ce1bfe5026a62063ee198bc342 (patch)
tree552d7e39af5bd55a4d18a65d4b7e8575e7689476
parent5dbda75a0208d1e1acd1d3bf26c4c44df0897dae (diff)
downloadcpython-75d5106bd0e026ce1bfe5026a62063ee198bc342.zip
cpython-75d5106bd0e026ce1bfe5026a62063ee198bc342.tar.gz
cpython-75d5106bd0e026ce1bfe5026a62063ee198bc342.tar.bz2
[ 912943 ] 7.5.6 Thread Objects is too vague
-rw-r--r--Doc/lib/libthreading.tex7
1 files changed, 6 insertions, 1 deletions
diff --git a/Doc/lib/libthreading.tex b/Doc/lib/libthreading.tex
index 3526974..33839a4 100644
--- a/Doc/lib/libthreading.tex
+++ b/Doc/lib/libthreading.tex
@@ -594,7 +594,12 @@ unhandled exception -- or until the optional timeout occurs.
When the \var{timeout} argument is present and not \code{None}, it
should be a floating point number specifying a timeout for the
-operation in seconds (or fractions thereof).
+operation in seconds (or fractions thereof). As \method{join()} always
+returns \code{None}, you must call \method{isAlive()} to decide whether
+a timeout happened.
+
+When the \var{timeout} argument is not present or \code{None}, the
+operation will block until the thread terminates.
A thread can be \method{join()}ed many times.