(original) (raw)

changeset: 68471:f6cab3819160 branch: 3.2 parent: 68469:a89d654adaa2 user: R David Murray rdmurray@bitdance.com date: Mon Mar 14 18:35:56 2011 -0400 files: Lib/email/generator.py Lib/email/header.py description: Harmonize linesep docstrings, and fix the quoting of \r\n diff -r a89d654adaa2 -r f6cab3819160 Lib/email/generator.py --- a/Lib/email/generator.py Mon Mar 14 17:10:22 2011 -0400 +++ b/Lib/email/generator.py Mon Mar 14 18:35:56 2011 -0400 @@ -59,7 +59,7 @@ 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 @@ 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 diff -r a89d654adaa2 -r f6cab3819160 Lib/email/header.py --- a/Lib/email/header.py Mon Mar 14 17:10:22 2011 -0400 +++ b/Lib/email/header.py Mon Mar 14 18:35:56 2011 -0400 @@ -276,7 +276,7 @@ self._chunks.append((s, charset)) def encode(self, splitchars=';, \t', maxlinelen=None, linesep='\n'): - """Encode a message header into an RFC-compliant format. + r"""Encode a message header into an RFC-compliant format. There are many issues involved in converting a given string for use in an email header. Only certain character sets are readable in most /rdmurray@bitdance.com