From: Barry Warsaw <barry@python.org>
Date: Mon, 10 May 2004 23:12:52 +0000 (+0000)
Subject: Added a note describing how fp should be opened in binary mode, especially on
X-Git-Tag: v2.4a1~408
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=dd69b0ab6c8ba25b6cdff65df30524411dee3cc8;p=python

Added a note describing how fp should be opened in binary mode, especially on
Windows.  Closes SF # 586899.
---

diff --git a/Doc/lib/libmailbox.tex b/Doc/lib/libmailbox.tex
index 947c2d33e1..767b67827f 100644
--- a/Doc/lib/libmailbox.tex
+++ b/Doc/lib/libmailbox.tex
@@ -18,6 +18,10 @@ argument, \var{fp} by the \method{next()} method of the mailbox
 object.  The default is the \class{rfc822.Message} class (see the
 \refmodule{rfc822} module -- and the note below).
 
+\note{For reasons of this module's internal implementation, you will probably
+want to open the \var{fp} object in binary mode.  This is especially important
+on Windows.}
+
 For maximum portability, messages in a \UNIX-style mailbox are
 separated by any line that begins exactly with the string \code{'From
 '} (note the trailing space) if preceded by exactly two newlines.