summaryrefslogtreecommitdiffstats
path: root/Doc/library/multiprocessing.rst
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2016-09-26 20:22:22 (GMT)
committerBerker Peksag <berker.peksag@gmail.com>2016-09-26 20:22:22 (GMT)
commita24d2d82746fcdeddd635394b22e5ab480cbad4d (patch)
treeaf5b7dde9db6a6fa91d170a9c4c01ed9cda38fa5 /Doc/library/multiprocessing.rst
parent8b6b50814e953abca74a1b7e03b56fa34d0183bd (diff)
downloadcpython-a24d2d82746fcdeddd635394b22e5ab480cbad4d.zip
cpython-a24d2d82746fcdeddd635394b22e5ab480cbad4d.tar.gz
cpython-a24d2d82746fcdeddd635394b22e5ab480cbad4d.tar.bz2
Issue #10673: Document that Process.exitcode can be used to determine timeout
Patch by Tom Clark.
Diffstat (limited to 'Doc/library/multiprocessing.rst')
-rw-r--r--Doc/library/multiprocessing.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index d20098f..a5912f7 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -496,6 +496,9 @@ The :mod:`multiprocessing` package mostly replicates the API of the
If the optional argument *timeout* is ``None`` (the default), the method
blocks until the process whose :meth:`join` method is called terminates.
If *timeout* is a positive number, it blocks at most *timeout* seconds.
+ Note that the method returns ``None`` if its process terminates or if the
+ method times out. Check the process's :attr:`exitcode` to determine if
+ it terminated.
A process can be joined many times.