Issue #10673: Document that Process.exitcode can be used to determine timeout

Patch by Tom Clark.

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index d20098ffa7c2e1da56e1550772d01c2ad4a8edc9..a5912f77a8648f07c03770db8cef78635e0b43a6 100644 (file)
--- 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.