summaryrefslogtreecommitdiffstats
path: root/Lib/email
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-05-07 01:33:18 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-05-07 01:33:18 (GMT)
commite25244657c5be459a98be06c745c35ff8a216c36 (patch)
tree00459a94dbf79f3037f4d698eccb307c1bc6e079 /Lib/email
parent3d139d8ed6712f39f4e91dc084ed421b76af09ae (diff)
downloadcpython-e25244657c5be459a98be06c745c35ff8a216c36.zip
cpython-e25244657c5be459a98be06c745c35ff8a216c36.tar.gz
cpython-e25244657c5be459a98be06c745c35ff8a216c36.tar.bz2
#21300: Clean up the docs for the email "policy" arguments.
Diffstat (limited to 'Lib/email')
-rw-r--r--Lib/email/generator.py9
1 files changed, 6 insertions, 3 deletions
diff --git a/Lib/email/generator.py b/Lib/email/generator.py
index 1535210..4735721 100644
--- a/Lib/email/generator.py
+++ b/Lib/email/generator.py
@@ -51,8 +51,9 @@ class Generator:
by RFC 2822.
The policy keyword specifies a policy object that controls a number of
- aspects of the generator's operation. The default policy maintains
- backward compatibility.
+ aspects of the generator's operation. If no policy is specified,
+ the policy associated with the Message object passed to the
+ flatten method is used.
"""
self._fp = outfp
@@ -76,7 +77,9 @@ 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 default value is determined by the policy.
+ the output. The default value is determined by the policy specified
+ when the Generator instance was created or, if none was specified,
+ from the policy associated with the msg.
"""
# We use the _XXX constants for operating on data that comes directly