[Python-checkins] python/dist/src/Doc/doc doc.tex,1.71,1.72

fdrake@users.sourceforge.net fdrake@users.sourceforge.net
Tue, 31 Dec 2002 07:05:07 -0800


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

Modified Files:
	doc.tex 
Log Message:
Define \mimeheader as a strongly-preferred spelling for \mailheader.

Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.71
retrieving revision 1.72
diff -C2 -d -r1.71 -r1.72
*** doc.tex	10 Oct 2002 18:24:50 -0000	1.71
--- doc.tex	31 Dec 2002 15:04:32 -0000	1.72
***************
*** 858,871 ****
  
      \begin{macrodesc}{mailheader}{\p{name}}
!       The name of an \rfc{822}-style mail header.  This markup does
!       not imply that the header is being used in an email message, but
!       can be used to refer to any header of the same ``style.''  This
!       is also used for headers defined by the various MIME
!       specifications.  The header name should be entered in the same
!       way it would normally be found in practice, with the
!       camel-casing conventions being preferred where there is more
!       than one common usage.  The colon which follows the name of the
!       header should not be included.
!       For example: \code{\e mailheader\{Content-Type\}}.
      \end{macrodesc}
  
--- 858,865 ----
  
      \begin{macrodesc}{mailheader}{\p{name}}
!       The same as \code{\e mimeheader\{\var{name}\}}.  The
!       \macro{mimeheader} macro is preferred, as this is used in
!       contexts beyond strictly email headers (for instance, HTTP
!       request headers).
      \end{macrodesc}
  
***************
*** 886,889 ****
--- 880,895 ----
        method name and the trailing parentheses.  A dotted name may be
        used.
+     \end{macrodesc}
+ 
+     \begin{macrodesc}{mimeheader}{\p{name}}
+       The name of an \rfc{2822}-style header.  This is used for both
+       email headers and headers defined by various MIME-related
+       specifications (including MIME applications, such as HTTP
+       request headers).  The header name should be entered in the same
+       way it would normally be found in practice, with the
+       camel-casing conventions being preferred where there is more
+       than one common usage.  The colon which follows the name of the
+       header should not be included.
+       For example: \code{\e mimeheader\{Content-Type\}}.
      \end{macrodesc}