[Python-checkins] bpo-15115: Document deprecation of email.encoders in Python 3 (GH-5354)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/464c1ec65af2c1c1d849d50d9726fa453804e70e
commit: 464c1ec65af2c1c1d849d50d9726fa453804e70e
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-05-31T13:26:01-07:00
summary:

bpo-15115: Document deprecation of email.encoders in Python 3 (GH-5354)

(cherry picked from commit a747c3a5edf21fa5670bc30f5e1d804de89ebf62)

Co-authored-by: Cheryl Sabella <cheryl.sabella at gmail.com>

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

diff --git a/Doc/library/email.encoders.rst b/Doc/library/email.encoders.rst
index e24ac7b90d29..debd1c85d490 100644
--- a/Doc/library/email.encoders.rst
+++ b/Doc/library/email.encoders.rst
@@ -12,6 +12,11 @@ This module is part of the legacy (``Compat32``) email API.  In the
 new API the functionality is provided by the *cte* parameter of
 the :meth:`~email.message.EmailMessage.set_content` method.
 
+This module is deprecated in Python 3.  The functions provided here
+should not be called explicitly since the :class:`~email.mime.text.MIMEText`
+class sets the content type and CTE header using the *_subtype* and *_charset*
+values passed during the instaniation of that class.
+
 The remaining text in this section is the original documentation of the module.
 
 When creating :class:`~email.message.Message` objects from scratch, you often