]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-15115: Document deprecation of email.encoders in Python 3 (GH-5354)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 31 May 2019 20:26:01 +0000 (13:26 -0700)
committerGitHub <noreply@github.com>
Fri, 31 May 2019 20:26:01 +0000 (13:26 -0700)
(cherry picked from commit a747c3a5edf21fa5670bc30f5e1d804de89ebf62)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
Doc/library/email.encoders.rst

index e24ac7b90d29f88eacf068f1c6e0a71837ab5510..debd1c85d490a0826e38125c7729b0fc4a4203c7 100644 (file)
@@ -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