diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2025-07-11 09:43:52 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-07-11 09:43:52 (GMT) |
| commit | aa4bb1c6857d215f97fd9bc40b97baf35992d1ea (patch) | |
| tree | 07f0231c4fc92fb3c4cac2be4016dad6340ec53b /Doc | |
| parent | aa3c6421ef8663ffeaeaee90862c1e6eb3d54931 (diff) | |
| download | cpython-aa4bb1c6857d215f97fd9bc40b97baf35992d1ea.zip cpython-aa4bb1c6857d215f97fd9bc40b97baf35992d1ea.tar.gz cpython-aa4bb1c6857d215f97fd9bc40b97baf35992d1ea.tar.bz2 | |
[3.13] gh-101100: Fix sphinx warnings in `library/email.parser.rst` (GH-136475) (#136533)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/email.parser.rst | 10 | ||||
| -rw-r--r-- | Doc/tools/.nitignore | 1 |
2 files changed, 5 insertions, 6 deletions
diff --git a/Doc/library/email.parser.rst b/Doc/library/email.parser.rst index 439b5c8..9079637 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 4b2ca6a..fc0fe42 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -16,7 +16,6 @@ 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/functools.rst Doc/library/http.cookiejar.rst Doc/library/http.server.rst |