summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-05-31 13:26:01 -0700
committerGitHub <noreply@github.com>2019-05-31 13:26:01 -0700
commit464c1ec65af2c1c1d849d50d9726fa453804e70e (patch)
tree010d5c10ad85cf1e11f7b9ec9c331fa484337059
parenta6dc5d4e1c9ef465dc1f1ad95c382aa8e32b178f (diff)
downloadcpython-git-464c1ec65af2c1c1d849d50d9726fa453804e70e.tar.gz
bpo-15115: Document deprecation of email.encoders in Python 3 (GH-5354)
(cherry picked from commit a747c3a5edf21fa5670bc30f5e1d804de89ebf62) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
-rw-r--r--Doc/library/email.encoders.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/library/email.encoders.rst b/Doc/library/email.encoders.rst
index e24ac7b90d..debd1c85d4 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