diff options
author | Fred Drake <fdrake@acm.org> | 1998-04-04 07:15:02 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 1998-04-04 07:15:02 (GMT) |
commit | fc57619811688c2ca885d285c651e0da59b88cc4 (patch) | |
tree | 5bfe87ac9bca13742b8a4a8a4bbd6766b3c8a6d1 /Doc/libmimetools.tex | |
parent | 71c1e502f0fba1dd40c4cc93b2143189d82a7672 (diff) | |
download | cpython-fc57619811688c2ca885d285c651e0da59b88cc4.zip cpython-fc57619811688c2ca885d285c651e0da59b88cc4.tar.gz cpython-fc57619811688c2ca885d285c651e0da59b88cc4.tar.bz2 |
Remove obsolete \setindexsubitem macros.
Massive migration to methoddesc and memberdesc.
Logical markup as needed.
A sprinkling of index entries for flavor.
Diffstat (limited to 'Doc/libmimetools.tex')
-rw-r--r-- | Doc/libmimetools.tex | 29 |
1 files changed, 13 insertions, 16 deletions
diff --git a/Doc/libmimetools.tex b/Doc/libmimetools.tex index 0d4e40f..54d1fe0 100644 --- a/Doc/libmimetools.tex +++ b/Doc/libmimetools.tex @@ -1,8 +1,7 @@ -\section{Standard Module \sectcode{mimetools}} +\section{Standard Module \module{mimetools}} \label{module-mimetools} \stmodindex{mimetools} -\setindexsubitem{(in module mimetools)} This module defines a subclass of the \class{rfc822.Message} class and a number of utility functions that are useful for the manipulation for @@ -53,9 +52,7 @@ open file \var{output}. The block size is currently fixed at 8192. The \class{Message} class defines the following methods in addition to the \class{rfc822.Message} methods: -\setindexsubitem{(mimetool.Message method)} - -\begin{funcdesc}{getplist}{} +\begin{methoddesc}{getplist}{} Return the parameter list of the \code{content-type} header. This is a list if strings. For parameters of the form \samp{\var{key}=\var{value}}, \var{key} is converted to lower case but @@ -63,36 +60,36 @@ a list if strings. For parameters of the form \samp{Content-type: text/html; spam=1; Spam=2; Spam} then \method{getplist()} will return the Python list \code{['spam=1', 'spam=2', 'Spam']}. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{getparam}{name} +\begin{methoddesc}{getparam}{name} Return the \var{value} of the first parameter (as returned by \method{getplist()} of the form \samp{\var{name}=\var{value}} for the given \var{name}. If \var{value} is surrounded by quotes of the form `\code{<}...\code{>}' or `\code{"}...\code{"}', these are removed. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{getencoding}{} +\begin{methoddesc}{getencoding}{} Return the encoding specified in the \code{content-transfer-encoding} message header. If no such header exists, return \code{'7bit'}. The encoding is converted to lower case. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{gettype}{} +\begin{methoddesc}{gettype}{} Return the message type (of the form \samp{\var{type}/\var{subtype}}) as specified in the \code{content-type} header. If no such header exists, return \code{'text/plain'}. The type is converted to lower case. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{getmaintype}{} +\begin{methoddesc}{getmaintype}{} Return the main type as specified in the \code{content-type} header. If no such header exists, return \code{'text'}. The main type is converted to lower case. -\end{funcdesc} +\end{methoddesc} -\begin{funcdesc}{getsubtype}{} +\begin{methoddesc}{getsubtype}{} Return the subtype as specified in the \code{content-type} header. If no such header exists, return \code{'plain'}. The subtype is converted to lower case. -\end{funcdesc} +\end{methoddesc} |