diff options
author | Barry Warsaw <barry@python.org> | 2004-10-03 03:39:47 (GMT) |
---|---|---|
committer | Barry Warsaw <barry@python.org> | 2004-10-03 03:39:47 (GMT) |
commit | 2ec4854f13027f091fe83c2108cf84fce83a58d6 (patch) | |
tree | c6f4c720606fc6ecf9d0e163ce935efe12a69022 | |
parent | 05bef930fa6a16f7b0bb1d2a145db4d79927dc70 (diff) | |
download | cpython-2ec4854f13027f091fe83c2108cf84fce83a58d6.zip cpython-2ec4854f13027f091fe83c2108cf84fce83a58d6.tar.gz cpython-2ec4854f13027f091fe83c2108cf84fce83a58d6.tar.bz2 |
Add documentation about as_string() mangling From_ lines.
-rw-r--r-- | Doc/lib/emailmessage.tex | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/lib/emailmessage.tex b/Doc/lib/emailmessage.tex index f732054..54e5cac 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} |