Skip to content

[3.13] Partially revert "gh-101100: Fix sphinx warnings in library/email.parser.rst (GH-136475)" (GH-136629) #136647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Doc/library/email.parser.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@
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,

Check warning on line 51 in Doc/library/email.parser.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

py:mod reference target not found: email.feedparser [ref.mod]
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
Expand Down Expand Up @@ -153,9 +153,9 @@

.. method:: parse(fp, headersonly=False)

Read all the data from the binary file-like object *fp*, parse the

Check warning on line 156 in Doc/library/email.parser.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs

py:meth reference target not found: io.IOBase.read [ref.meth]
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`
Expand Down
1 change: 1 addition & 0 deletions Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Doc/library/ast.rst
Doc/library/asyncio-extending.rst
Doc/library/asyncio-policy.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
Expand Down
Loading