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

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/doc
In directory slayer.i.sourceforge.net:/tmp/cvs-serv23995/doc

Modified Files:
	doc.tex 
Log Message:

Add documentation for the \pep and \seepep macros.


Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.25
retrieving revision 1.26
diff -C2 -r1.25 -r1.26
*** doc.tex	2000/09/07 20:06:07	1.25
--- doc.tex	2000/09/11 05:22:30	1.26
***************
*** 535,538 ****
--- 535,545 ----
      \end{macrodesc}
  
+     \begin{macrodesc}{pep}{\p{number}}
+       A reference to a Python Enhancement Proposal.  This generates
+       appropriate index entries.  The text \samp{PEP \var{number}} is
+       generated; in the HTML output, this text is a hyperlink to an
+       online copy of the specified PEP.
+     \end{macrodesc}
+ 
      \begin{macrodesc}{refmodule}{\op{key}\p{name}}
        Like \macro{module}, but create a hyperlink to the documentation 
***************
*** 812,822 ****
      \end{macrodesc}
  
!     \begin{macrodesc}{seerfc}{\p{number}\p{title}\p{why}}
!       Refer to an IETF Request for Comments (RFC).  \var{number}
!       should be the official number assigned by the RFC Editor,
!       \var{title} should be the human-readable title of the RFC as
        found in the official copy of the document, and \var{why} should
!       explain what's interesting about the RFC.  This should be used
!       to refer the reader to RFCs which specify protocols or data
        formats relevant to the material in the annotated section of the
        documentation.
--- 819,837 ----
      \end{macrodesc}
  
!     \begin{macrodesc}{seepep}{\p{number}\p{title}\p{why}}
!       Refer to an Python Enhancement Proposal (PEP).  \var{number}
!       should be the official number assigned by the PEP Editor,
!       \var{title} should be the human-readable title of the PEP as
        found in the official copy of the document, and \var{why} should
!       explain what's interesting about the PEP.  This should be used
!       to refer the reader to PEPs which specify interfaces or language
!       features relevant to the material in the annotated section of the
!       documentation.
!     \end{macrodesc}
! 
!     \begin{macrodesc}{seerfc}{\p{number}\p{title}\p{why}}
!       Refer to an IETF Request for Comments (RFC).  Otherwise very
!       similar to \macro{seepep}.  This should be used
!       to refer the reader to PEPs which specify protocols or data
        formats relevant to the material in the annotated section of the
        documentation.