diff Doc/lib/libthread.tex @ 8564:e87d22c7de3c legacy-trunk

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.
author Guido van Rossum <guido@python.org>
date Sat, 27 Jun 1998 18:25:44 +0000
parents 8e5223680a9d
children 46b472ecb0f9
line wrap: on
line diff
--- a/Doc/lib/libthread.tex	Sat Jun 27 18:21:59 1998 +0000
+++ b/Doc/lib/libthread.tex	Sat Jun 27 18:25:44 1998 +0000
@@ -24,21 +24,27 @@
 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}