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

[Fred L. Drake]

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

Modified Files:
	doc.tex 
Log Message:
New markup:  \note{...} and \warning{...}

Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.54
retrieving revision 1.55
diff -C2 -d -r1.54 -r1.55
*** doc.tex	2001/09/26 18:43:20	1.54
--- doc.tex	2001/10/09 18:01:23	1.55
***************
*** 860,863 ****
--- 860,871 ----
      \end{macrodesc}
  
+     \begin{macrodesc}{note}{\p{text}}
+       An especially important bit of information about an API that a
+       user should be aware of when using whatever bit of API the
+       note pertains to.  This should be the last thing in the
+       paragraph as the end of the note is not visually marked in
+       any way.
+     \end{macrodesc}
+ 
      \begin{macrodesc}{pep}{\p{number}}
        A reference to a Python Enhancement Proposal.  This generates
***************
*** 988,991 ****
--- 996,1008 ----
        \macro{versionadded}.  The location should be selected so the
        explanation makes sense and may vary as needed.
+     \end{macrodesc}
+ 
+     \begin{macrodesc}{warning}{\p{text}}
+       An important bit of information about an API that a user should
+       be very aware of when using whatever bit of API the warning
+       pertains to.  This should be the last thing in the paragraph as
+       the end of the warning is not visually marked in any way.  This
+       differs from \macro{note} in that it is recommended over
+       \macro{note} for information regarding security.
      \end{macrodesc}