summaryrefslogtreecommitdiffstats
path: root/Lib
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2011-03-14 22:39:41 (GMT)
committerR David Murray <rdmurray@bitdance.com>2011-03-14 22:39:41 (GMT)
commit45725727187c7413b2a16f812160244e19787615 (patch)
treeacd949f9e5a2664ac4be05d081fe02ed8d956a9d /Lib
parent750beda5353e3433df3978b6e9e3d57b6253e066 (diff)
parentcd37dfcfac956d6400659dd2d208bcf81f32aebc (diff)
downloadcpython-45725727187c7413b2a16f812160244e19787615.zip
cpython-45725727187c7413b2a16f812160244e19787615.tar.gz
cpython-45725727187c7413b2a16f812160244e19787615.tar.bz2
Merge linesep docstring changes from 3.2.
Diffstat (limited to 'Lib')
-rw-r--r--Lib/email/generator.py7
-rw-r--r--Lib/email/header.py2
2 files changed, 6 insertions, 3 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
diff --git a/Lib/email/header.py b/Lib/email/header.py
index 35cdb2b..e171617 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