diff options
| author | R David Murray <rdmurray@bitdance.com> | 2011-03-14 22:39:41 (GMT) |
|---|---|---|
| committer | R David Murray <rdmurray@bitdance.com> | 2011-03-14 22:39:41 (GMT) |
| commit | 45725727187c7413b2a16f812160244e19787615 (patch) | |
| tree | acd949f9e5a2664ac4be05d081fe02ed8d956a9d /Lib/email/generator.py | |
| parent | 750beda5353e3433df3978b6e9e3d57b6253e066 (diff) | |
| parent | cd37dfcfac956d6400659dd2d208bcf81f32aebc (diff) | |
| download | cpython-45725727187c7413b2a16f812160244e19787615.zip cpython-45725727187c7413b2a16f812160244e19787615.tar.gz cpython-45725727187c7413b2a16f812160244e19787615.tar.bz2 | |
Merge linesep docstring changes from 3.2.
Diffstat (limited to 'Lib/email/generator.py')
| -rw-r--r-- | Lib/email/generator.py | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Lib/email/generator.py b/Lib/email/generator.py index 531fa9a..f0e7a95 100644 --- a/Lib/email/generator.py +++ b/Lib/email/generator.py @@ -59,7 +59,7 @@ class Generator: self._fp.write(s) def flatten(self, msg, unixfrom=False, linesep='\n'): - """Print the message object tree rooted at msg to the output file + r"""Print the message object tree rooted at msg to the output file specified when the Generator instance was created. unixfrom is a flag that forces the printing of a Unix From_ delimiter @@ -70,7 +70,10 @@ class Generator: Note that for subobjects, no From_ line is printed. linesep specifies the characters used to indicate a new line in - the output. + the output. The default value is the most useful for typical + Python applications, but it can be set to \r\n to produce RFC-compliant + line separators when needed. + """ # We use the _XXX constants for operating on data that comes directly # from the msg, and _encoded_XXX constants for operating on data that |