summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libthread.tex
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1998-06-27 18:25:44 (GMT)
committerGuido van Rossum <guido@python.org>1998-06-27 18:25:44 (GMT)
commit73d8bff44db83299d5642fc2c57b761aa9feaabf (patch)
treecc394429b3d48faf60024076c8528e95c2a497c8 /Doc/lib/libthread.tex
parenta70d160095aa9b2b9b6f5af2ea7ee692c14037ad (diff)
downloadcpython-73d8bff44db83299d5642fc2c57b761aa9feaabf.zip
cpython-73d8bff44db83299d5642fc2c57b761aa9feaabf.tar.gz
cpython-73d8bff44db83299d5642fc2c57b761aa9feaabf.tar.bz2
Document optional kwargs argument to start_new_thread(). Also
document new LockType and reverse the preference for exit() vs. exit_thread() -- exit() is now preferred and exit_thread() is obsolete.
Diffstat (limited to 'Doc/lib/libthread.tex')
-rw-r--r--Doc/lib/libthread.tex18
1 files changed, 12 insertions, 6 deletions
diff --git a/Doc/lib/libthread.tex b/Doc/lib/libthread.tex
index 9e9d8ba..9bc1849 100644
--- a/Doc/lib/libthread.tex
+++ b/Doc/lib/libthread.tex
@@ -24,21 +24,27 @@ It defines the following constant and functions:
Raised on thread-specific errors.
\end{excdesc}
-\begin{funcdesc}{start_new_thread}{func, arg}
-Start a new thread. The thread executes the function \var{func}
-with the argument list \var{arg} (which must be a tuple). When the
+\begin{datadesc}{LockType}
+This is the type of lock objects.
+\end{datadesc}
+
+\begin{funcdesc}{start_new_thread}{function, args\optional{kwargs}}
+Start a new thread. The thread executes the function \var{function}
+with the argument list \var{args} (which must be a tuple). The
+optional \var{kwargs} argument specifies a dictionary of keyword
+arguments. When the
function returns, the thread silently exits. When the function
terminates with an unhandled exception, a stack trace is printed and
then the thread exits (but other threads continue to run).
\end{funcdesc}
\begin{funcdesc}{exit}{}
-This is a shorthand for \function{exit_thread()}.
+Raise the \exception{SystemExit} exception. When not caught, this
+will cause the thread to exit silently.
\end{funcdesc}
\begin{funcdesc}{exit_thread}{}
-Raise the \exception{SystemExit} exception. When not caught, this
-will cause the thread to exit silently.
+This is an obsolete synonym for \function{exit()}.
\end{funcdesc}
%\begin{funcdesc}{exit_prog}{status}