Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ea00205

Browse files
committed
Use \rfc to mark some remaining RFC references.
Remove comment about full name bug in getaddrlist(); this has been fixed for a while now. Work around LaTeX2HTML space-dropping bug. Mention that the fp attribute can be used to read the message body.
1 parent 5712fa9 commit ea00205

1 file changed

Lines changed: 10 additions & 12 deletions

File tree

Doc/lib/librfc822.tex

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ \section{\module{rfc822} ---
88
collection of ``email headers'' as defined by the Internet standard
99
\rfc{822}. It is used in various contexts, usually to read such
1010
headers from a file. This module also defines a helper class
11-
\class{AddressList} for parsing RFC822 addresses.
11+
\class{AddressList} for parsing \rfc{822} addresses.
1212

1313
Note that there's a separate module to read \UNIX{}, MH, and MMDF
1414
style mailbox files: \refmodule{mailbox}\refstmodindex{mailbox}.
@@ -86,8 +86,8 @@ \section{\module{rfc822} ---
8686
switch dates. Not enough to worry about for common use.
8787
\end{funcdesc}
8888

89-
\subsection{Message Objects}
90-
\label{message-objects}
89+
90+
\subsection{Message Objects \label{message-objects}}
9191

9292
A \class{Message} instance has the following methods:
9393

@@ -98,7 +98,7 @@ \subsection{Message Objects}
9898

9999
\begin{methoddesc}{isheader}{line}
100100
Returns a line's canonicalized fieldname (the dictionary key that will
101-
be used to index it) if the line is a legal RFC822 header; otherwise
101+
be used to index it) if the line is a legal \rfc{822} header; otherwise
102102
returns None (implying that parsing should stop here and the line be
103103
pushed back on the input stream). It is sometimes useful to override
104104
this method in a subclass.
@@ -126,8 +126,8 @@ \subsection{Message Objects}
126126

127127
\begin{methoddesc}{getfirstmatchingheader}{name}
128128
Return a list of lines comprising the first header matching
129-
\var{name}, and its continuation line(s), if any. Return \code{None}
130-
if there is no header matching \var{name}.
129+
\var{name}, and its continuation line(s), if any. Return
130+
\code{None} if there is no header matching \var{name}.
131131
\end{methoddesc}
132132

133133
\begin{methoddesc}{getrawheader}{name}
@@ -176,9 +176,6 @@ \subsection{Message Objects}
176176
If multiple headers exist that match the named header (e.g. if there
177177
are several \code{Cc} headers), all are parsed for addresses. Any
178178
continuation lines the named headers contain are also parsed.
179-
180-
XXX The current version of this function is not really correct. It
181-
yields bogus results if a full name contains a comma.
182179
\end{methoddesc}
183180

184181
\begin{methoddesc}{getdate}{name}
@@ -219,11 +216,12 @@ \subsection{Message Objects}
219216
\end{memberdesc}
220217

221218
\begin{memberdesc}{fp}
222-
The file object passed at instantiation time.
219+
The file or file-like object passed at instantiation time. This can
220+
be used to read the message content.
223221
\end{memberdesc}
224222

225-
\subsection{AddressList Objects}
226-
\label{addresslist-objects}
223+
224+
\subsection{AddressList Objects \label{addresslist-objects}}
227225

228226
An \class{AddressList} instance has the following methods:
229227

0 commit comments

Comments
 (0)