mirror of https://github.com/python/cpython
24277: Make it clearer that the new modules are not provisional.
Also make it clear on the contents page what chapters are about the legacy API.
This commit is contained in:
parent
ff4fddde57
commit
7f730cf01d
|
@ -11,9 +11,7 @@
|
||||||
|
|
||||||
------------
|
------------
|
||||||
|
|
||||||
.. versionadded:: 3.4 as a :term:`provisional module <provisional package>`.
|
.. versionadded:: 3.6 [1]_
|
||||||
|
|
||||||
.. versionchanged:: 3.6 provisional status removed.
|
|
||||||
|
|
||||||
|
|
||||||
.. class:: ContentManager()
|
.. class:: ContentManager()
|
||||||
|
@ -201,3 +199,9 @@ Currently the email package provides only one concrete content manager,
|
||||||
``headername: headervalue`` or a list of ``header`` objects
|
``headername: headervalue`` or a list of ``header`` objects
|
||||||
(distinguished from strings by having a ``name`` attribute), add the
|
(distinguished from strings by having a ``name`` attribute), add the
|
||||||
headers to *msg*.
|
headers to *msg*.
|
||||||
|
|
||||||
|
|
||||||
|
.. rubric:: Footnotes
|
||||||
|
|
||||||
|
.. [1] Oringally added in 3.4 as a :term:`provisional module <provisional
|
||||||
|
package>`
|
||||||
|
|
|
@ -11,9 +11,7 @@
|
||||||
|
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
.. versionadded:: 3.3 as a :term:`provisional module <provisional package>`.
|
.. versionadded:: 3.6 [1]_
|
||||||
|
|
||||||
.. versionchanged:: 3.6 provisonal status removed.
|
|
||||||
|
|
||||||
Headers are represented by customized subclasses of :class:`str`. The
|
Headers are represented by customized subclasses of :class:`str`. The
|
||||||
particular class used to represent a given header is determined by the
|
particular class used to represent a given header is determined by the
|
||||||
|
@ -449,3 +447,9 @@ construct structured values to assign to specific headers.
|
||||||
``display_name`` is none and there is a single ``Address`` in the
|
``display_name`` is none and there is a single ``Address`` in the
|
||||||
``addresses`` list, the ``str`` value will be the same as the ``str`` of
|
``addresses`` list, the ``str`` value will be the same as the ``str`` of
|
||||||
that single ``Address``.
|
that single ``Address``.
|
||||||
|
|
||||||
|
|
||||||
|
.. rubric:: Footnotes
|
||||||
|
|
||||||
|
.. [1] Oringally added in 3.3 as a :term:`provisional module <provisional
|
||||||
|
package>`
|
||||||
|
|
|
@ -11,13 +11,7 @@
|
||||||
|
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
.. versionadded:: 3.4
|
.. versionadded:: 3.6 [1]_
|
||||||
the classes documented here were added :term:`provisionaly <provisional
|
|
||||||
package>`.
|
|
||||||
|
|
||||||
.. versionchanged:: 3.6
|
|
||||||
provisional status removed, docs for legacy message class moved
|
|
||||||
to :ref:`compat32_message`.
|
|
||||||
|
|
||||||
The central class in the :mod:`email` package is the :class:`EmailMessage`
|
The central class in the :mod:`email` package is the :class:`EmailMessage`
|
||||||
class, imported from the :mod:`email.message` module. It is the base class for
|
class, imported from the :mod:`email.message` module. It is the base class for
|
||||||
|
@ -748,3 +742,10 @@ message objects.
|
||||||
:class:`EmailMessage`, except that no :mailheader:`MIME-Version` headers are
|
:class:`EmailMessage`, except that no :mailheader:`MIME-Version` headers are
|
||||||
added when :meth:`~EmailMessage.set_content` is called, since sub-parts do
|
added when :meth:`~EmailMessage.set_content` is called, since sub-parts do
|
||||||
not need their own :mailheader:`MIME-Version` headers.
|
not need their own :mailheader:`MIME-Version` headers.
|
||||||
|
|
||||||
|
|
||||||
|
.. rubric:: Footnotes
|
||||||
|
|
||||||
|
.. [1] Oringally added in 3.4 as a :term:`provisional module <provisional
|
||||||
|
package>`. Docs for legacy message class moved to
|
||||||
|
:ref:`compat32_message`.
|
||||||
|
|
|
@ -371,9 +371,7 @@ added matters. To illustrate::
|
||||||
In addition to the settable attributes listed above that apply to all
|
In addition to the settable attributes listed above that apply to all
|
||||||
policies, this policy adds the following additional attributes:
|
policies, this policy adds the following additional attributes:
|
||||||
|
|
||||||
.. versionadded:: 3.3 as a :term:`provisional feature <provisional package>`.
|
.. versionadded:: 3.6 [1]_
|
||||||
|
|
||||||
.. versionchanged:: 3.6 provisional status removed.
|
|
||||||
|
|
||||||
|
|
||||||
.. attribute:: utf8
|
.. attribute:: utf8
|
||||||
|
@ -634,3 +632,9 @@ The header objects and their attributes are described in
|
||||||
|
|
||||||
An instance of :class:`Compat32`, providing backward compatibility with the
|
An instance of :class:`Compat32`, providing backward compatibility with the
|
||||||
behavior of the email package in Python 3.2.
|
behavior of the email package in Python 3.2.
|
||||||
|
|
||||||
|
|
||||||
|
.. rubric:: Footnotes
|
||||||
|
|
||||||
|
.. [1] Oringally added in 3.3 as a :term:`provisional feature <provisional
|
||||||
|
package>`.
|
||||||
|
|
|
@ -97,6 +97,11 @@ can be useful tools. This documentation is also relevant for applications that
|
||||||
are still using the :mod:`~email.policy.compat32` API for backward
|
are still using the :mod:`~email.policy.compat32` API for backward
|
||||||
compatibility reasons.
|
compatibility reasons.
|
||||||
|
|
||||||
|
.. versionchanged:: 3.6
|
||||||
|
Docs reorganized and rewritten to promote the new
|
||||||
|
:class:`~email.message.EmailMessage`/:class:`~email.policy.EmailPolicy`
|
||||||
|
API.
|
||||||
|
|
||||||
Contents of the :mod:`email` package documentation:
|
Contents of the :mod:`email` package documentation:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
@ -112,6 +117,10 @@ Contents of the :mod:`email` package documentation:
|
||||||
|
|
||||||
email.examples.rst
|
email.examples.rst
|
||||||
|
|
||||||
|
Legacy API:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
|
||||||
email.compat32-message.rst
|
email.compat32-message.rst
|
||||||
email.mime.rst
|
email.mime.rst
|
||||||
email.header.rst
|
email.header.rst
|
||||||
|
|
Loading…
Reference in New Issue