summaryrefslogtreecommitdiffstats
path: root/Doc/library/email.generator.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-05-17 11:28:33 (GMT)
committerGeorg Brandl <georg@python.org>2009-05-17 11:28:33 (GMT)
commit3f076d8b3df3a1aa3228bbe993d4f37d577fcc2f (patch)
tree5af0b00e845c6bad851015467bca470aaeb78c62 /Doc/library/email.generator.rst
parentfe66fc120cfcc10fc38990c6c9c3c8a0b4d585bc (diff)
downloadcpython-3f076d8b3df3a1aa3228bbe993d4f37d577fcc2f.zip
cpython-3f076d8b3df3a1aa3228bbe993d4f37d577fcc2f.tar.gz
cpython-3f076d8b3df3a1aa3228bbe993d4f37d577fcc2f.tar.bz2
Use new optional argument style in email docs.
Diffstat (limited to 'Doc/library/email.generator.rst')
-rw-r--r--Doc/library/email.generator.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/email.generator.rst b/Doc/library/email.generator.rst
index 0f5788a..2061f76 100644
--- a/Doc/library/email.generator.rst
+++ b/Doc/library/email.generator.rst
@@ -23,7 +23,7 @@ Here are the public methods of the :class:`Generator` class, imported from the
:mod:`email.generator` module:
-.. class:: Generator(outfp[, mangle_from_[, maxheaderlen]])
+.. class:: Generator(outfp, mangle_from_=True, maxheaderlen=78)
The constructor for the :class:`Generator` class takes a file-like object called
*outfp* for an argument. *outfp* must support the :meth:`write` method and be
@@ -47,7 +47,7 @@ Here are the public methods of the :class:`Generator` class, imported from the
The other public :class:`Generator` methods are:
- .. method:: flatten(msg[, unixfrom])
+ .. method:: flatten(msg, unixfrom=False)
Print the textual representation of the message object structure rooted at
*msg* to the output file specified when the :class:`Generator` instance
@@ -84,7 +84,7 @@ except that non-\ :mimetype:`text` parts are substituted with a format string
representing the part.
-.. class:: DecodedGenerator(outfp[, mangle_from_[, maxheaderlen[, fmt]]])
+.. class:: DecodedGenerator(outfp[, mangle_from_=True, maxheaderlen=78, fmt=None)
This class, derived from :class:`Generator` walks through all the subparts of a
message. If the subpart is of main type :mimetype:`text`, then it prints the