summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-05-11 01:01:12 (GMT)
committerFred Drake <fdrake@acm.org>2001-05-11 01:01:12 (GMT)
commit9f2376de7a4b9c26193ced8b6767410b6b54390b (patch)
tree8be197ebb898d7969c5a90340721a84da8e0caf7
parent06a01e84b90129d3edb8e9620972733a88bae4fb (diff)
downloadcpython-9f2376de7a4b9c26193ced8b6767410b6b54390b.zip
cpython-9f2376de7a4b9c26193ced8b6767410b6b54390b.tar.gz
cpython-9f2376de7a4b9c26193ced8b6767410b6b54390b.tar.bz2
Document the new classdesc* environment, and the previously undocumented
excclassdesc environment.
-rw-r--r--Doc/doc/doc.tex19
1 files changed, 18 insertions, 1 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index a86c450..2275797 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -519,9 +519,19 @@ This \UNIX\ is also followed by a space.
Like \env{datadesc}, but without creating any index entries.
\end{envdesc}
+ \begin{envdesc}{excclassdesc}{\p{name}\p{constructor parameters}}
+ Descibe an exception defined by a class. \var{constructor
+ parameters} should not include the \var{self} parameter or
+ the parentheses used in the call syntax. To describe an
+ exception class without describing the parameters to its
+ constructor, use the \env{excdesc} environment.
+ \end{envdesc}
+
\begin{envdesc}{excdesc}{\p{name}}
Describe an exception. This may be either a string exception or
- a class exception.
+ a class exception. In the case of class exceptions, the
+ constructor parameters are not described; use \env{excclassdesc}
+ to describe an exception class and its constructor.
\end{envdesc}
\begin{envdesc}{funcdesc}{\p{name}\p{parameters}}
@@ -547,6 +557,13 @@ This \UNIX\ is also followed by a space.
the parentheses used in the call syntax.
\end{envdesc}
+ \begin{envdesc}{classdesc*}{\p{name}}
+ Describe a class without describing the constructor. This can
+ be used to describe classes that are merely containers for
+ attributes or which should never be instantiated or subclassed
+ by user code.
+ \end{envdesc}
+
\begin{envdesc}{memberdesc}{\op{type name}\p{name}}
Describe an object data attribute. The description should
include information about the type of the data to be expected