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

[Fred L. Drake]

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

Modified Files:
	doc.tex 
Log Message:
Add a new environment for whole-paragraph (or longer) notes & warnings.

Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.57
retrieving revision 1.58
diff -C2 -d -r1.57 -r1.58
*** doc.tex	2001/11/30 18:09:48	1.57
--- doc.tex	2001/12/14 22:50:05	1.58
***************
*** 1011,1014 ****
--- 1011,1033 ----
  
  
+   \subsection{Miscellaneous Text Markup \label{misc-text-markup}}
+ 
+   In addition to the inline markup, some additional ``block'' markup
+   is defined to make it easier to bring attention to various bits of
+   text.  The markup described here serves this purpose, and is
+   intended to be used when marking one or more paragraphs or other
+   block constructs (such as \env{verbatim} environments).
+ 
+   \begin{envdesc}{notice}{\op{type}}
+     Label some paragraphs as being worthy of additional attention from
+     the reader.  What sort of attention is warrented can be indicated
+     by specifying the \var{type} of the notice.  The only values
+     defined for \var{type} are \code{note} and \code{warning}; these
+     are equivalent in intent to the inline markup of the same name.
+     If \var{type} is omitted, \code{note} is used.  Additional values
+     may be defined in the future.
+   \end{envdesc}
+ 
+ 
    \subsection{Module-specific Markup \label{module-markup}}