Skip to content

Commit efbd165

Browse files
gh-151947: Fix all Sphinx reference warnings in email.{charset,parser}.rst (#152178)
Co-authored-by: Stan Ulbrych <stan@python.org>
1 parent d441a11 commit efbd165

4 files changed

Lines changed: 6 additions & 8 deletions

File tree

‎Doc/library/email.charset.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,8 @@ new entries to the global character set, alias, and codec registries:
183183

184184
Optional *output_charset* is the character set that the output should be in.
185185
Conversions will proceed from input charset, to Unicode, to the output charset
186-
when the method :meth:`Charset.convert` is called. The default is to output in
187-
the same character set as the input.
186+
when the method :meth:`Charset.body_encode` is called. The default is to
187+
output in the same character set as the input.
188188

189189
Both *input_charset* and *output_charset* must have Unicode codec entries in the
190190
module's character set-to-codec mapping; use :func:`add_codec` to add codecs the

‎Doc/library/email.parser.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ methods.
4848
FeedParser API
4949
^^^^^^^^^^^^^^
5050

51-
The :class:`BytesFeedParser`, imported from the :mod:`email.feedparser` module,
51+
The :class:`BytesFeedParser`, imported from the :mod:`!email.feedparser` module,
5252
provides an API that is conducive to incremental parsing of email messages,
5353
such as would be necessary when reading the text of an email message from a
5454
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`:
8686
more information on what else *policy* controls, see the
8787
:mod:`~email.policy` documentation.
8888

89-
Note: **The policy keyword should always be specified**; The default will
89+
Note: **The policy keyword should always be specified**. The default will
9090
change to :data:`email.policy.default` in a future version of Python.
9191

9292
.. versionadded:: 3.2
@@ -142,7 +142,7 @@ message body, instead setting the payload to the raw body.
142142
arguments have the same meaning and semantics as the *_factory*
143143
and *policy* arguments of :class:`BytesFeedParser`.
144144

145-
Note: **The policy keyword should always be specified**; The default will
145+
Note: **The policy keyword should always be specified**. The default will
146146
change to :data:`email.policy.default` in a future version of Python.
147147

148148
.. versionchanged:: 3.3

‎Doc/tools/.nitignore‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44

55
Doc/library/ast.rst
66
Doc/library/asyncio-extending.rst
7-
Doc/library/email.charset.rst
8-
Doc/library/email.parser.rst
97
Doc/library/logging.config.rst
108
Doc/library/logging.handlers.rst
119
Doc/library/multiprocessing.rst

‎Lib/email/charset.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ def add_charset(charset, header_enc=None, body_enc=None, output_charset=None):
151151
152152
Optional output_charset is the character set that the output should be
153153
in. Conversions will proceed from input charset, to Unicode, to the
154-
output charset when the method Charset.convert() is called. The default
154+
output charset when the method Charset.body_encode() is called. The default
155155
is to output in the same character set as the input.
156156
157157
Both input_charset and output_charset must have Unicode codec entries in

0 commit comments

Comments
 (0)