mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 08:59:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Document the new classdesc* environment, and the previously undocumented

Browse source 
excclassdesc environment.
This commit is contained in:
Fred Drake 2001-05-11 01:01:12 +00:00
parent 06a01e84b9
commit 9f2376de7a
1 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

19
Doc/doc/doc.tex
View file

@ -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