cpython: 64e82c4f4e10 (original) (raw)
Mercurial > cpython
changeset 77187:64e82c4f4e10
#11785: fix the :mod: references in email package submodule titles. Also adds the TOC entry for headerregistry. [#11785]
line wrap: on
line diff
--- a/Doc/library/email.charset.rst
+++ b/Doc/library/email.charset.rst
@@ -1,5 +1,5 @@
-:mod:email
: Representing character sets
------------------------------------------
+:mod:email.charset
: Representing character sets
+-------------------------------------------------
.. module:: email.charset
:synopsis: Character Sets
--- a/Doc/library/email.encoders.rst
+++ b/Doc/library/email.encoders.rst
@@ -1,5 +1,5 @@
-:mod:email
: Encoders
-----------------------
+:mod:email.encoders
: Encoders
+-------------------------------
.. module:: email.encoders
:synopsis: Encoders for email message payloads.
--- a/Doc/library/email.errors.rst
+++ b/Doc/library/email.errors.rst
@@ -1,5 +1,5 @@
-:mod:email
: Exception and Defect classes
-------------------------------------------
+:mod:email.errors
: Exception and Defect classes
+-------------------------------------------------
.. module:: email.errors
:synopsis: The exception classes used by the email package.
--- a/Doc/library/email.generator.rst
+++ b/Doc/library/email.generator.rst
@@ -1,5 +1,5 @@
-:mod:email
: Generating MIME documents
----------------------------------------
+:mod:email.generator
: Generating MIME documents
+-------------------------------------------------
.. module:: email.generator
:synopsis: Generate flat text email messages from a message structure.
--- a/Doc/library/email.header.rst
+++ b/Doc/library/email.header.rst
@@ -1,5 +1,5 @@
-:mod:email
: Internationalized headers
----------------------------------------
+:mod:email.header
: Internationalized headers
+----------------------------------------------
.. module:: email.header
:synopsis: Representing non-ASCII headers
--- a/Doc/library/email.headerregistry.rst +++ b/Doc/library/email.headerregistry.rst @@ -4,6 +4,10 @@ .. module:: email.headerregistry :synopsis: Automatic Parsing of headers based on the field name +.. moduleauthor:: R. David Murray rdmurray@bitdance.com +.. sectionauthor:: R. David Murray rdmurray@bitdance.com + + .. note:: The headerregistry module has been included in the standard library on a
--- a/Doc/library/email.iterators.rst
+++ b/Doc/library/email.iterators.rst
@@ -1,5 +1,5 @@
-:mod:email
: Iterators
------------------------
+:mod:email.iterators
: Iterators
+---------------------------------
.. module:: email.iterators
:synopsis: Iterate over a message object tree.
--- a/Doc/library/email.message.rst
+++ b/Doc/library/email.message.rst
@@ -1,5 +1,5 @@
-:mod:email
: Representing an email message
--------------------------------------------
+:mod:email.message
: Representing an email message
+---------------------------------------------------
.. module:: email.message
:synopsis: The base class representing email messages.
--- a/Doc/library/email.mime.rst
+++ b/Doc/library/email.mime.rst
@@ -1,5 +1,5 @@
-:mod:email
: Creating email and MIME objects from scratch
-----------------------------------------------------------
+:mod:email.mime
: Creating email and MIME objects from scratch
+---------------------------------------------------------------
.. module:: email.mime
:synopsis: Build MIME messages.
--- a/Doc/library/email.parser.rst
+++ b/Doc/library/email.parser.rst
@@ -1,5 +1,5 @@
-:mod:email
: Parsing email messages
-------------------------------------
+:mod:email.parser
: Parsing email messages
+-------------------------------------------
.. module:: email.parser
:synopsis: Parse flat text email messages to produce a message object structure.
--- a/Doc/library/email.policy.rst
+++ b/Doc/library/email.policy.rst
@@ -1,9 +1,12 @@
-:mod:email
: Policy Objects
-----------------------------
+:mod:email.policy
: Policy Objects
+-----------------------------------
.. module:: email.policy
:synopsis: Controlling the parsing and generating of messages
+.. moduleauthor:: R. David Murray rdmurray@bitdance.com
+.. sectionauthor:: R. David Murray rdmurray@bitdance.com
+
.. versionadded:: 3.3
--- a/Doc/library/email.rst
+++ b/Doc/library/email.rst
@@ -52,6 +52,7 @@ Contents of the :mod:email
package doc
email.parser.rst
email.generator.rst
email.policy.rst
--- a/Doc/library/email.util.rst
+++ b/Doc/library/email.util.rst
@@ -1,5 +1,5 @@
-:mod:email
: Miscellaneous utilities
--------------------------------------
+:mod:email.utils
: Miscellaneous utilities
+-------------------------------------------
.. module:: email.utils
:synopsis: Miscellaneous email package utilities.