Minor changes. Explain that for class exceptions, use excdesc but do not

freddrake · freddrake · commit e1a85f5e4a7c · 2000-07-06T16:12:47.000Z
document the constructor parameters.  Need a better way, but this will do
for now.
diff --git a/Doc/templates/module.tex b/Doc/templates/module.tex
@@ -84,7 +84,7 @@ \section{\module{spam} ---
 
 \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
+\var{mode} and \var{buffersize} arguments specify the read/write mode
 (\code{'r'} (default) or \code{'w'}) and the buffer size (default:
 system dependent).
 \end{funcdesc}
@@ -101,7 +101,9 @@ \section{\module{spam} ---
 
 % --- 3.3. ---
 % Exceptions are described using a ``excdesc'' block.  This has only
-% one parameter: the exception name.
+% 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}
 Exception raised when an operation fails for a Spam specific reason.
@@ -129,8 +131,7 @@ \section{\module{spam} ---
 % an example giving the flavor of the module may be given before the
 % detailed list of functions.)
 
-\subsection{Example}
-\nodename{Spam Example}
+\subsection{Example \label{spam-example}}
 
 The following example demonstrates how to open a can of spam using the
 \module{spam} module.
