]> granicus.if.org Git - python/commitdiff
Add documentation about as_string() mangling From_ lines.
authorBarry Warsaw <barry@python.org>
Sun, 3 Oct 2004 03:39:47 +0000 (03:39 +0000)
committerBarry Warsaw <barry@python.org>
Sun, 3 Oct 2004 03:39:47 +0000 (03:39 +0000)
Doc/lib/emailmessage.tex

index f732054350ce306bbfa86f12c5f6f924be633993..54e5cac991b0570c498b040bef5c328187e88935 100644 (file)
@@ -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}