Skip to content

Commit e1a85f5

Browse files
committed
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.
1 parent e3889da commit e1a85f5

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

Doc/templates/module.tex

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ \section{\module{spam} ---
8484

8585
\begin{funcdesc}{open}{filename\optional{, mode\optional{, buffersize}}}
8686
Open the file \var{filename} as a can of Spam. The optional
87-
\var{mode} and \var{buffersize} arguments specify the read-write mode
87+
\var{mode} and \var{buffersize} arguments specify the read/write mode
8888
(\code{'r'} (default) or \code{'w'}) and the buffer size (default:
8989
system dependent).
9090
\end{funcdesc}
@@ -101,7 +101,9 @@ \section{\module{spam} ---
101101

102102
% --- 3.3. ---
103103
% Exceptions are described using a ``excdesc'' block. This has only
104-
% one parameter: the exception name.
104+
% one parameter: the exception name. Exceptions defined as classes in
105+
% the source code should be documented using this environment, but
106+
% constructor parameters must be ommitted.
105107

106108
\begin{excdesc}{error}
107109
Exception raised when an operation fails for a Spam specific reason.
@@ -129,8 +131,7 @@ \section{\module{spam} ---
129131
% an example giving the flavor of the module may be given before the
130132
% detailed list of functions.)
131133

132-
\subsection{Example}
133-
\nodename{Spam Example}
134+
\subsection{Example \label{spam-example}}
134135

135136
The following example demonstrates how to open a can of spam using the
136137
\module{spam} module.

0 commit comments

Comments
 (0)