[Python-checkins] CVS: python/dist/src/Doc/lib libthreading.tex,1.7,1.8

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv11469/lib

Modified Files:
	libthreading.tex 
Log Message:

Some general cleanup of the threading module documentation, including
fixing the reference to Thread.getDeamon() (should be isDaemon()).

This closes SF bug #429070.


Index: libthreading.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libthreading.tex,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -r1.7 -r1.8
*** libthreading.tex	1999/04/23 20:07:02	1.7
--- libthreading.tex	2001/05/31 20:24:07	1.8
***************
*** 69,75 ****
  \end{funcdesc}
  
! \begin{classdesc}{Thread}{}
  A class that represents a thread of control.  This class can be safely subclassed in a limited fashion.
! \end{classdesc}
  
  Detailed interfaces for the objects are documented below.  
--- 69,75 ----
  \end{funcdesc}
  
! \begin{classdesc*}{Thread}{}
  A class that represents a thread of control.  This class can be safely subclassed in a limited fashion.
! \end{classdesc*}
  
  Detailed interfaces for the objects are documented below.  
***************
*** 445,449 ****
  daemon threads are left.  The initial value is inherited from the
  creating thread.  The flag can be set with the \method{setDaemon()}
! method and retrieved with the \method{getDaemon()} method.
  
  There is a ``main thread'' object; this corresponds to the
--- 445,449 ----
  daemon threads are left.  The initial value is inherited from the
  creating thread.  The flag can be set with the \method{setDaemon()}
! method and retrieved with the \method{isDaemon()} method.
  
  There is a ``main thread'' object; this corresponds to the
***************
*** 465,488 ****
  This constructor should always be called with keyword
  arguments.  Arguments are:
  
! \var{group}
! Should be \code{None}; reserved for future extension when a
! \class{ThreadGroup} class is implemented.
! 
! \var{target}
! Callable object to be invoked by the \method{run()} method.
! Defaults to \code{None}, meaning nothing is called.
! 
! \var{name}
! The thread name.  By default, a unique name is constructed of the form
! ``Thread-\var{N}'' where \var{N} is a small decimal number.
! 
! \var{args}
! Argument tuple for the target invocation.  Defaults to \code{()}.
! 
! \var{kwargs}
! Keyword argument dictionary for the target invocation.
! Defaults to \code{\{\}}.
  
  If the subclass overrides the constructor, it must make sure
  to invoke the base class constructor (\code{Thread.__init__()})
--- 465,486 ----
  This constructor should always be called with keyword
  arguments.  Arguments are:
+ 
+ \var{group} should be \code{None}; reserved for future extension when
+ a \class{ThreadGroup} class is implemented.
+ 
+ \var{target} is the callable object to be invoked by the
+ \method{run()} method.  Defaults to \code{None}, meaning nothing is
+ called.
+ 
+ \var{name} is the thread name.  By default, a unique name is
+ constructed of the form ``Thread-\var{N}'' where \var{N} is a small
+ decimal number.
  
! \var{args} is the argument tuple for the target invocation.  Defaults
! to \code{()}.
  
+ \var{kwargs} is a dictionary of keyword arguments for the target
+ invocation.  Defaults to \code{\{\}}.
+ 
  If the subclass overrides the constructor, it must make sure
  to invoke the base class constructor (\code{Thread.__init__()})
***************
*** 490,495 ****
  \end{classdesc}
  
- 
- 
  \begin{methoddesc}{start}{}
  Start the thread's activity.
--- 488,491 ----
***************
*** 500,505 ****
  \end{methoddesc}
  
- 
- 
  \begin{methoddesc}{run}{}
  Method representing the thread's activity.
--- 496,499 ----
***************
*** 512,516 ****
  \end{methoddesc}
  
- 
  \begin{methoddesc}{join}{\optional{timeout}}
  Wait until the thread terminates.
--- 506,509 ----
***************
*** 532,537 ****
  \end{methoddesc}
  
- 
- 
  \begin{methoddesc}{getName}{}
  Return the thread's name.
--- 525,528 ----
***************
*** 566,568 ****
  threads are left.
  \end{methoddesc}
- 
--- 557,558 ----