summaryrefslogtreecommitdiffstats
path: root/Doc/templates
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-07-06 16:12:47 (GMT)
committerFred Drake <fdrake@acm.org>2000-07-06 16:12:47 (GMT)
commite1a85f5e4a7cde096e3c10fb2a8e9f4f26fc1231 (patch)
tree9befe44660d0ece3ca9a804e1472ae69de9c5f38 /Doc/templates
parente3889da0762776008260a8d3c9489c6aa00aa844 (diff)
downloadcpython-e1a85f5e4a7cde096e3c10fb2a8e9f4f26fc1231.zip
cpython-e1a85f5e4a7cde096e3c10fb2a8e9f4f26fc1231.tar.gz
cpython-e1a85f5e4a7cde096e3c10fb2a8e9f4f26fc1231.tar.bz2
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.
Diffstat (limited to 'Doc/templates')
-rw-r--r--Doc/templates/module.tex9
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/templates/module.tex b/Doc/templates/module.tex
index 107848f..33d769d 100644
--- a/Doc/templates/module.tex
+++ b/Doc/templates/module.tex
@@ -84,7 +84,7 @@ The \module{spam} module defines the following functions:
\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 @@ once the \function{open()} function has been called.
% --- 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 @@ failure.
% 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.