From: Georg Brandl <georg@python.org>
Date: Sun, 17 Jul 2005 21:00:31 +0000 (+0000)
Subject: backport [ 912943 ] 7.5.6 Thread Objects is too vague
X-Git-Tag: v2.4.2c1~132
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6912a6ca6aedfd7809b1315d1f7cd9c4a1e59c18;p=thirdparty%2FPython%2Fcpython.git

backport [ 912943 ] 7.5.6 Thread Objects is too vague
---

diff --git a/Doc/lib/libthreading.tex b/Doc/lib/libthreading.tex
index 35269748af32..33839a4306a1 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.