mirror of
https://github.com/python/cpython.git
synced 2026-10-28 10:25:05 +08:00
gh-151947: Fix all Sphinx reference warnings in email.{charset,parser}.rst (#152178)
Co-authored-by: Stan Ulbrych <stan@python.org>
This commit is contained in:
1 parent
d441a118fa
commit
efbd165392
4 files changed
+6
-8
No files matched your search
@@ -183,8 +183,8 @@ new entries to the global character set, alias, and codec registries:
|
||||
|
||||
Optional *output_charset* is the character set that the output should be in.
|
||||
Conversions will proceed from input charset, to Unicode, to the output charset
|
||||
when the method :meth:`Charset.convert` is called. The default is to output in
|
||||
the same character set as the input.
|
||||
when the method :meth:`Charset.body_encode` is called. The default is to
|
||||
output in the same character set as the input.
|
||||
|
||||
Both *input_charset* and *output_charset* must have Unicode codec entries in the
|
||||
module's character set-to-codec mapping; use :func:`add_codec` to add codecs the
|
||||
|
||||
@@ -48,7 +48,7 @@ methods.
|
||||
FeedParser API
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
The :class:`BytesFeedParser`, imported from the :mod:`email.feedparser` module,
|
||||
The :class:`BytesFeedParser`, imported from the :mod:`!email.feedparser` module,
|
||||
provides an API that is conducive to incremental parsing of email messages,
|
||||
such as would be necessary when reading the text of an email message from a
|
||||
source that can block (such as a socket). The :class:`BytesFeedParser` can of
|
||||
@@ -86,7 +86,7 @@ Here is the API for the :class:`BytesFeedParser`:
|
||||
more information on what else *policy* controls, see the
|
||||
:mod:`~email.policy` documentation.
|
||||
|
||||
Note: **The policy keyword should always be specified**; The default will
|
||||
Note: **The policy keyword should always be specified**. The default will
|
||||
change to :data:`email.policy.default` in a future version of Python.
|
||||
|
||||
.. versionadded:: 3.2
|
||||
@@ -142,7 +142,7 @@ message body, instead setting the payload to the raw body.
|
||||
arguments have the same meaning and semantics as the *_factory*
|
||||
and *policy* arguments of :class:`BytesFeedParser`.
|
||||
|
||||
Note: **The policy keyword should always be specified**; The default will
|
||||
Note: **The policy keyword should always be specified**. The default will
|
||||
change to :data:`email.policy.default` in a future version of Python.
|
||||
|
||||
.. versionchanged:: 3.3
|
||||
|
||||
@@ -4,8 +4,6 @@
|
||||
|
||||
Doc/library/ast.rst
|
||||
Doc/library/asyncio-extending.rst
|
||||
Doc/library/email.charset.rst
|
||||
Doc/library/email.parser.rst
|
||||
Doc/library/logging.config.rst
|
||||
Doc/library/logging.handlers.rst
|
||||
Doc/library/multiprocessing.rst
|
||||
|
||||
@@ -151,7 +151,7 @@ def add_charset(charset, header_enc=None, body_enc=None, output_charset=None):
|
||||
|
||||
Optional output_charset is the character set that the output should be
|
||||
in. Conversions will proceed from input charset, to Unicode, to the
|
||||
output charset when the method Charset.convert() is called. The default
|
||||
output charset when the method Charset.body_encode() is called. The default
|
||||
is to output in the same character set as the input.
|
||||
|
||||
Both input_charset and output_charset must have Unicode codec entries in
|
||||
|
||||
Reference in new issue
Block a user