summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2011-03-15 18:02:53 (GMT)
committerR David Murray <rdmurray@bitdance.com>2011-03-15 18:02:53 (GMT)
commit4a0b60c5273451909d8bd6e538c140c9c42593c7 (patch)
tree06981310160786f980cdfcec7165929025400d94 /Doc
parentb78b4d7bf5264ae23f10c750883d7bd97fdb3afb (diff)
parent7dedcb46441803444a3bdb0f9773d9d9b10186e9 (diff)
downloadcpython-4a0b60c5273451909d8bd6e538c140c9c42593c7.zip
cpython-4a0b60c5273451909d8bd6e538c140c9c42593c7.tar.gz
cpython-4a0b60c5273451909d8bd6e538c140c9c42593c7.tar.bz2
Merge #11555 as_string doc fix from 3.1.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/email.message.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst
index 11984a5..ebe2d9c 100644
--- a/Doc/library/email.message.rst
+++ b/Doc/library/email.message.rst
@@ -46,15 +46,16 @@ Here are the methods of the :class:`Message` class:
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()