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

[Fred L. Drake]

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

Modified Files:
	doc.tex 
Log Message:
Describe the content given as the parameter to the \note and \warning macros
in more detail, and use them where appropriate.


Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.55
retrieving revision 1.56
diff -C2 -d -r1.55 -r1.56
*** doc.tex	2001/10/09 18:01:23	1.55
--- doc.tex	2001/10/20 04:18:14	1.56
***************
*** 777,782 ****
        outputs, single quotes and a font change are used to indicate
        the file name, but no quotes are used in the HTML output.
!       \strong{Warning:} The \macro{file} macro cannot be used in the
!       content of a section title due to processing limitations.
      \end{macrodesc}
  
--- 777,782 ----
        outputs, single quotes and a font change are used to indicate
        the file name, but no quotes are used in the HTML output.
!       \warning{The \macro{file} macro cannot be used in the
!       content of a section title due to processing limitations.}
      \end{macrodesc}
  
***************
*** 785,790 ****
        be used in conjunction with tables if a column will only contain 
        file or directory names.
!       \strong{Warning:} The \macro{filenq} macro cannot be used in the
!       content of a section title due to processing limitations.
      \end{macrodesc}
  
--- 785,790 ----
        be used in conjunction with tables if a column will only contain 
        file or directory names.
!       \warning{The \macro{filenq} macro cannot be used in the
!       content of a section title due to processing limitations.}
      \end{macrodesc}
  
***************
*** 865,869 ****
        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}
  
--- 865,870 ----
        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.  The content of \var{text} should be written in
!       complete sentences and include all appropriate punctuation.
      \end{macrodesc}
  
***************
*** 1002,1008 ****
        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}
  
--- 1003,1011 ----
        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.  The
!       content of \var{text} should be written in complete sentences
!       and include all appropriate punctuation.  This differs from
!       \macro{note} in that it is recommended over \macro{note} for
!       information regarding security.
      \end{macrodesc}
  
***************
*** 1328,1333 ****
        \var{key} if necessary.  In the HTML and PDF conversions, the
        module name will be a hyperlink to the referred-to module.
!       \strong{Note:}  The module must be documented in the same
!       document (the corresponding \macro{declaremodule} is required).
      \end{macrodesc}
  
--- 1331,1336 ----
        \var{key} if necessary.  In the HTML and PDF conversions, the
        module name will be a hyperlink to the referred-to module.
!       \note{The module must be documented in the same
!       document (the corresponding \macro{declaremodule} is required).}
      \end{macrodesc}