[Python-checkins] CVS: python/dist/src/Doc/doc doc.tex,1.40,1.41

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/doc
In directory usw-pr-cvs1:/tmp/cvs-serv1526/doc

Modified Files:
	doc.tex 
Log Message:

Document the new classdesc* environment, and the previously undocumented
excclassdesc environment.


Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.40
retrieving revision 1.41
diff -C2 -r1.40 -r1.41
*** doc.tex	2001/04/18 05:19:06	1.40
--- doc.tex	2001/05/11 01:01:12	1.41
***************
*** 520,526 ****
      \end{envdesc}
  
      \begin{envdesc}{excdesc}{\p{name}}
        Describe an exception.  This may be either a string exception or
!       a class exception.
      \end{envdesc}
  
--- 520,536 ----
      \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.  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}
  
***************
*** 546,549 ****
--- 556,566 ----
        parameters} should not include the \var{self} parameter or
        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}