[Python-checkins] cpython (3.1): #11555: update doc for 3.x change to as_string mangle_from default.

[r.david.murray]

http://hg.python.org/cpython/rev/2804a78a123e
changeset:   68508:2804a78a123e
branch:      3.1
parent:      68505:1ba77f3ccc2e
user:        R David Murray <rdmurray at bitdance.com>
date:        Tue Mar 15 14:01:18 2011 -0400
summary:
  #11555: update doc for 3.x change to as_string mangle_from default.

files:
  Doc/library/email.message.rst
  Lib/email/message.py

diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst
--- a/Doc/library/email.message.rst
+++ b/Doc/library/email.message.rst
@@ -46,15 +46,16 @@
       be generated or modified).
 
       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 mangles
-      lines that begin with ``From``.  For more flexibility, instantiate a
+      format the message the way you want.  For example, by default it does
+      not do the mangling of lines that begin with ``From`` that is
+      required by the unix mbox format.  For more flexibility, instantiate a
       :class:`~email.generator.Generator` instance and use its :meth:`flatten`
       method directly.  For example::
 
          from io import StringIO
          from email.generator import Generator
          fp = StringIO()
-         g = Generator(fp, mangle_from_=False, maxheaderlen=60)
+         g = Generator(fp, mangle_from_=True, maxheaderlen=60)
          g.flatten(msg)
          text = fp.getvalue()
 
diff --git a/Lib/email/message.py b/Lib/email/message.py
--- a/Lib/email/message.py
+++ b/Lib/email/message.py
@@ -136,8 +136,7 @@
         header.
 
         This is a convenience method and may not generate the message exactly
-        as you intend because by default it mangles lines that begin with
-        "From ".  For more flexibility, use the flatten() method of a
+        as you intend.  For more flexibility, use the flatten() method of a
         Generator instance.
         """
         from email.generator import Generator

-- 
Repository URL: http://hg.python.org/cpython