]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
backport [ 912943 ] 7.5.6 Thread Objects is too vague
authorGeorg Brandl <georg@python.org>
Sun, 17 Jul 2005 21:00:31 +0000 (21:00 +0000)
committerGeorg Brandl <georg@python.org>
Sun, 17 Jul 2005 21:00:31 +0000 (21:00 +0000)
Doc/lib/libthreading.tex

index 35269748af32bea2f7e3dc133d447cd2fc11a2a3..33839a4306a130d8fd08c9e30e2d2036bcbc9886 100644 (file)
@@ -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.