https://github.com/python/cpython/commit/515b3d18edfce00ce441e0e41091d0dd57f201ad
commit: 515b3d18edfce00ce441e0e41091d0dd57f201ad
branch: main
author: Weilin Du <[email protected]>
committer: hugovk <[email protected]>
date: 2025-07-11T12:37:01+03:00
summary:
gh-101100: Fix sphinx warnings in `library/email.parser.rst` (#136475)
files:
M Doc/library/email.parser.rst
M Doc/tools/.nitignore
diff --git a/Doc/library/email.parser.rst b/Doc/library/email.parser.rst
index 439b5c8f34b65a..90796370ebb407 100644
--- a/Doc/library/email.parser.rst
+++ b/Doc/library/email.parser.rst
@@ -48,8 +48,8 @@ methods.
FeedParser API
^^^^^^^^^^^^^^
-The :class:`BytesFeedParser`, imported from the :mod:`email.feedparser` module,
-provides an API that is conducive to incremental parsing of email messages,
+The :class:`BytesFeedParser`, imported from the :mod:`email.parser.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
course be used to parse an email message fully contained in a :term:`bytes-like
@@ -116,7 +116,7 @@ Here is the API for the :class:`BytesFeedParser`:
Works like :class:`BytesFeedParser` except that the input to the
:meth:`~BytesFeedParser.feed` method must be a string. This is of limited
utility, since the only way for such a message to be valid is for it to
- contain only ASCII text or, if :attr:`~email.policy.Policy.utf8` is
+ contain only ASCII text or, if :attr:`~email.policy.EmailPolicy.utf8` is
``True``, no binary attachments.
.. versionchanged:: 3.3 Added the *policy* keyword.
@@ -155,11 +155,11 @@ message body, instead setting the payload to the raw body.
Read all the data from the binary file-like object *fp*, parse the
resulting bytes, and return the message object. *fp* must support
- both the :meth:`~io.IOBase.readline` and the :meth:`~io.IOBase.read`
+ both the :meth:`~io.IOBase.readline` and the :meth:`~io.TextIOBase.read`
methods.
The bytes contained in *fp* must be formatted as a block of :rfc:`5322`
- (or, if :attr:`~email.policy.Policy.utf8` is ``True``, :rfc:`6532`)
+ (or, if :attr:`~email.policy.EmailPolicy.utf8` is ``True``, :rfc:`6532`)
style headers and header continuation lines, optionally preceded by an
envelope header. The header block is terminated either by the end of the
data or by a blank line. Following the header block is the body of the
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 4f5396857f3024..897b404b8d6bb3 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -15,7 +15,6 @@ Doc/extending/extending.rst
Doc/library/ast.rst
Doc/library/asyncio-extending.rst
Doc/library/email.charset.rst
-Doc/library/email.parser.rst
Doc/library/functools.rst
Doc/library/http.cookiejar.rst
Doc/library/http.server.rst
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
