[Python-checkins] bpo-31887: Adds documentations for special multipart/signed handling (GH-4268)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/622935d9a69d12e125e470ce9a9ff3cad9e8e296
commit: 622935d9a69d12e125e470ce9a9ff3cad9e8e296
branch: master
author: Saptak Sengupta <saptak013 at gmail.com>
committer: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
date: 2018-11-04T14:12:34-08:00
summary:

bpo-31887: Adds documentations for special multipart/signed handling (GH-4268)



This pull request adds some information about the special multipart/signed handling to clear about disabling header folding.


https://bugs.python.org/issue31887

files:
M Doc/library/email.generator.rst

diff --git a/Doc/library/email.generator.rst b/Doc/library/email.generator.rst
index 2575a5130070..fc535a3e4399 100644
--- a/Doc/library/email.generator.rst
+++ b/Doc/library/email.generator.rst
@@ -36,6 +36,10 @@ something that contains only ASCII characters, using the standard email RFC
 Content Transfer Encoding techniques for encoding email messages for transport
 over channels that are not "8 bit clean".
 
+To accomodate reproducible processing of SMIME-signed messages
+:class:`Generator` disables header folding for message parts of type
+``multipart/signed`` and all subparts.
+
 
 .. class:: BytesGenerator(outfp, mangle_from_=None, maxheaderlen=None, *, \
                           policy=None)