Skip to content

Commit 2910f37

Browse files
committed
Move policy note for EmailMessage doc to footnotes
1 parent 6d2cbf5 commit 2910f37

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

Doc/library/email.message.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,7 @@ message objects.
5757
:class:`~email.policy.default` policy, which follows the rules of the email
5858
RFCs except for line endings (instead of the RFC mandated ``\r\n``, it uses
5959
the Python standard ``\n`` line endings). For more information see the
60-
:mod:`~email.policy` documentation.
61-
62-
.. note::
63-
64-
The :class:`EmailMessage` class requires a policy that provides a
65-
``content_manager`` attribute for content management methods like
66-
:meth:`set_content` and :meth:`get_content` to work.
67-
The legacy :class:`~email.policy.Compat32` policy does not support
68-
these methods and should not be used with :class:`EmailMessage`.
60+
:mod:`~email.policy` documentation. [2]_
6961

7062
.. method:: as_string(unixfrom=False, maxheaderlen=None, policy=None)
7163

@@ -757,3 +749,9 @@ message objects.
757749
.. [1] Originally added in 3.4 as a :term:`provisional module <provisional
758750
package>`. Docs for legacy message class moved to
759751
:ref:`compat32_message`.
752+
753+
.. [2] The :class:`EmailMessage` class requires a policy that provides a
754+
``content_manager`` attribute for content management methods like
755+
:meth:`set_content` and :meth:`get_content` to work. The legacy
756+
:const:`~email.policy.compat32` policy does not support these methods
757+
and should not be used with :class:`EmailMessage`.

0 commit comments

Comments
 (0)