[Python-checkins] CVS: python/dist/src/Doc/templates module.tex,1.20,1.21

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/templates
In directory slayer.i.sourceforge.net:/tmp/cvs-serv11738

Modified Files:
	module.tex 
Log Message:

Minor changes.  Explain that for class exceptions, use excdesc but do not
document the constructor parameters.  Need a better way, but this will do
for now.


Index: module.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/templates/module.tex,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -r1.20 -r1.21
*** module.tex	2000/07/06 13:43:37	1.20
--- module.tex	2000/07/06 16:12:47	1.21
***************
*** 85,89 ****
  \begin{funcdesc}{open}{filename\optional{, mode\optional{, buffersize}}}
  Open the file \var{filename} as a can of Spam.  The optional
! \var{mode} and \var{buffersize} arguments specify the read-write mode
  (\code{'r'} (default) or \code{'w'}) and the buffer size (default:
  system dependent).
--- 85,89 ----
  \begin{funcdesc}{open}{filename\optional{, mode\optional{, buffersize}}}
  Open the file \var{filename} as a can of Spam.  The optional
! \var{mode} and \var{buffersize} arguments specify the read/write mode
  (\code{'r'} (default) or \code{'w'}) and the buffer size (default:
  system dependent).
***************
*** 102,106 ****
  % --- 3.3. ---
  % Exceptions are described using a ``excdesc'' block.  This has only
! % one parameter: the exception name.
  
  \begin{excdesc}{error}
--- 102,108 ----
  % --- 3.3. ---
  % Exceptions are described using a ``excdesc'' block.  This has only
! % one parameter: the exception name.  Exceptions defined as classes in
! % the source code should be documented using this environment, but
! % constructor parameters must be ommitted.
  
  \begin{excdesc}{error}
***************
*** 130,135 ****
  % detailed list of functions.)
  
! \subsection{Example}
! \nodename{Spam Example}
  
  The following example demonstrates how to open a can of spam using the
--- 132,136 ----
  % detailed list of functions.)
  
! \subsection{Example \label{spam-example}}
  
  The following example demonstrates how to open a can of spam using the