https://github.com/python/cpython/commit/5bbf30e89e7e1cb0a2b9bed9e0e99be291becbd3
commit: 5bbf30e89e7e1cb0a2b9bed9e0e99be291becbd3
branch: main
author: Hugo van Kemenade <[email protected]>
committer: hugovk <[email protected]>
date: 2025-07-14T12:13:15+03:00
summary:
Partially revert "gh-101100: Fix sphinx warnings in `library/email.parser.rst`
(#136475)" (#136629)
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 90796370ebb407..6a70714dc3ee42 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.parser.FeedParser`
-module, provides an API that is conducive to incremental parsing of email
messages,
+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
course be used to parse an email message fully contained in a :term:`bytes-like
@@ -155,7 +155,7 @@ 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.TextIOBase.read`
+ both the :meth:`~io.IOBase.readline` and the :meth:`~io.IOBase.read`
methods.
The bytes contained in *fp* must be formatted as a block of :rfc:`5322`
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 510225afab8933..31b2e567f11056 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -15,6 +15,7 @@ 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/http.cookiejar.rst
Doc/library/http.server.rst
Doc/library/importlib.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]
