diff options
author | Serhiy Storchaka <storchaka@gmail.com> | 2013-08-19 06:59:18 (GMT) |
---|---|---|
committer | Serhiy Storchaka <storchaka@gmail.com> | 2013-08-19 06:59:18 (GMT) |
commit | e0f0cf406757cea35db0aeaad592c2418d521b45 (patch) | |
tree | f2b28faff6f7e583abc5251ddb19aa1c05da280e /Doc/library/email.headerregistry.rst | |
parent | ca64d25dd285a784186bc16b3ee39ff8680cabdf (diff) | |
download | cpython-e0f0cf406757cea35db0aeaad592c2418d521b45.zip cpython-e0f0cf406757cea35db0aeaad592c2418d521b45.tar.gz cpython-e0f0cf406757cea35db0aeaad592c2418d521b45.tar.bz2 |
Issue #18761: Improved cross-references in email documentation.
Diffstat (limited to 'Doc/library/email.headerregistry.rst')
-rw-r--r-- | Doc/library/email.headerregistry.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/Doc/library/email.headerregistry.rst b/Doc/library/email.headerregistry.rst index c884159..db3aade 100644 --- a/Doc/library/email.headerregistry.rst +++ b/Doc/library/email.headerregistry.rst @@ -56,15 +56,16 @@ headers. .. attribute:: name The name of the header (the portion of the field before the ':'). This - is exactly the value passed in the :attr:`~EmailPolicy.header_factory` - call for *name*; that is, case is preserved. + is exactly the value passed in the + :attr:`~email.policy.EmailPolicy.header_factory` call for *name*; that + is, case is preserved. .. attribute:: defects A tuple of :exc:`~email.errors.HeaderDefect` instances reporting any RFC compliance problems found during parsing. The email package tries to - be complete about detecting compliance issues. See the :mod:`errors` + be complete about detecting compliance issues. See the :mod:`~email.errors` module for a discussion of the types of defects that may be reported. @@ -230,8 +231,8 @@ headers. The single address encoded by the header value. If the header value actually contains more than one address (which would be a violation of - the RFC under the default :mod:`policy`), accessing this attribute will - result in a :exc:`ValueError`. + the RFC under the default :mod:`~email.policy`), accessing this attribute + will result in a :exc:`ValueError`. Many of the above classes also have a ``Unique`` variant (for example, @@ -275,7 +276,7 @@ variant, :attr:`~.BaseHeader.max_count` is set to 1. .. class:: ContentTypeHeader - A :class:`ParameterizedMIMEHheader` class that handles the + A :class:`ParameterizedMIMEHeader` class that handles the :mailheader:`Content-Type` header. .. attribute:: content_type @@ -289,7 +290,7 @@ variant, :attr:`~.BaseHeader.max_count` is set to 1. .. class:: ContentDispositionHeader - A :class:`ParameterizedMIMEHheader` class that handles the + A :class:`ParameterizedMIMEHeader` class that handles the :mailheader:`Content-Disposition` header. .. attribute:: content-disposition |