From: R David Murray Date: Mon, 14 Mar 2011 22:35:56 +0000 (-0400) Subject: Harmonize linesep docstrings, and fix the quoting of \r\n X-Git-Tag: v3.2.1b1~306 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=cd37dfcfac956d6400659dd2d208bcf81f32aebc;p=python Harmonize linesep docstrings, and fix the quoting of \r\n --- diff --git a/Lib/email/generator.py b/Lib/email/generator.py index 531fa9a7a4..f0e7a95477 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 diff --git a/Lib/email/header.py b/Lib/email/header.py index 35cdb2b405..e1716176fa 100644 --- a/Lib/email/header.py +++ b/Lib/email/header.py @@ -276,7 +276,7 @@ class Header: 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