From: Barry Warsaw <barry@python.org>
Date: Sun, 3 Oct 2004 03:39:47 +0000 (+0000)
Subject: Add documentation about as_string() mangling From_ lines.
X-Git-Tag: v2.4b1~108
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2ec4854f13027f091fe83c2108cf84fce83a58d6;p=python

Add documentation about as_string() mangling From_ lines.
---

diff --git a/Doc/lib/emailmessage.tex b/Doc/lib/emailmessage.tex
index f732054350..54e5cac991 100644
--- a/Doc/lib/emailmessage.tex
+++ b/Doc/lib/emailmessage.tex
@@ -37,9 +37,10 @@ Return the entire message flatten as a string.  When optional
 \var{unixfrom} is \code{True}, the envelope header is included in the
 returned string.  \var{unixfrom} defaults to \code{False}.
 
-Note that this method is provided as a convenience and may not always
-format the message the way you want.  For more flexibility,
-instantiate a \class{Generator} instance and use its
+Note that this method is provided as a convenience and may not always format
+the message the way you want.  For example, by default it mangels lines that
+begin with \code{From }.  For more flexibility, instantiate a
+\class{Generator} instance and use its
 \method{flatten()} method directly.  For example:
 
 \begin{verbatim}