]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
24277: Make it clearer that the new modules are not provisional.
authorR David Murray <rdmurray@bitdance.com>
Thu, 8 Sep 2016 22:28:43 +0000 (18:28 -0400)
committerR David Murray <rdmurray@bitdance.com>
Thu, 8 Sep 2016 22:28:43 +0000 (18:28 -0400)
Also make it clear on the contents page what chapters are about the
legacy API.

Doc/library/email.contentmanager.rst
Doc/library/email.headerregistry.rst
Doc/library/email.message.rst
Doc/library/email.policy.rst
Doc/library/email.rst

index c1b103ee89df03bf89411c880d83309c41e74185..57743d5a29f1dd1df6cd89ecc8c733cd4a1885bf 100644 (file)
@@ -11,9 +11,7 @@
 
 ------------
 
-.. versionadded:: 3.4 as a :term:`provisional module <provisional package>`.
-
-.. versionchanged:: 3.6 provisional status removed.
+.. versionadded:: 3.6 [1]_
 
 
 .. class:: ContentManager()
@@ -201,3 +199,9 @@ Currently the email package provides only one concrete content manager,
        ``headername: headervalue`` or a list of ``header`` objects
        (distinguished from strings by having a ``name`` attribute), add the
        headers to *msg*.
+
+
+.. rubric:: Footnotes
+
+.. [1] Oringally added in 3.4 as a :term:`provisional module <provisional
+       package>`
index feec497bd98486932d7c868298572d320de3c676..2c830cfd81fb47ea83afcc214122633f0e2018b4 100644 (file)
@@ -11,9 +11,7 @@
 
 --------------
 
-.. versionadded:: 3.3 as a :term:`provisional module <provisional package>`.
-
-.. versionchanged:: 3.6 provisonal status removed.
+.. versionadded:: 3.6 [1]_
 
 Headers are represented by customized subclasses of :class:`str`.  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
       ``addresses`` list, the ``str`` value will be the same as the ``str`` of
       that single ``Address``.
+
+
+.. rubric:: Footnotes
+
+.. [1] Oringally added in 3.3 as a :term:`provisional module <provisional
+       package>`
index c888673dda18c71a9db5f64ae15d083ff9dcca37..95136d2b84aa85bb5a45065e8c8e09fd26653578 100644 (file)
 
 --------------
 
-.. versionadded:: 3.4
-   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`.
+.. versionadded:: 3.6 [1]_
 
 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
@@ -748,3 +742,10 @@ message objects.
     :class:`EmailMessage`, except that no :mailheader:`MIME-Version` headers are
     added when :meth:`~EmailMessage.set_content` is called, since sub-parts do
     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`.
index 0d6c27ac5e8954fbadf77d4d54790b1ff2b7105b..b499ed829d27ac11408055a57159bee92123e8f3 100644 (file)
@@ -371,9 +371,7 @@ added matters.  To illustrate::
    In addition to the settable attributes listed above that apply to all
    policies, this policy adds the following additional attributes:
 
-   .. versionadded:: 3.3 as a :term:`provisional feature <provisional package>`.
-
-   .. versionchanged:: 3.6 provisional status removed.
+   .. versionadded:: 3.6 [1]_
 
 
    .. 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
    behavior of the email package in Python 3.2.
+
+
+.. rubric:: Footnotes
+
+.. [1] Oringally added in 3.3 as a :term:`provisional feature <provisional
+       package>`.
index 01bd3801e070357e70a11e1e5fb66ffc1faaa1c6..c4187dd0098d1a6cf257456ba5f05b013abfbb2f 100644 (file)
@@ -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
 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:
 
 .. toctree::
@@ -112,6 +117,10 @@ Contents of the :mod:`email` package documentation:
 
    email.examples.rst
 
+Legacy API:
+
+.. toctree::
+
    email.compat32-message.rst
    email.mime.rst
    email.header.rst