Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.4k
gh-101100: Fix sphinx warnings inlibrary/email.parser.rst
#136475
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -48,8 +48,8 @@ methods. | ||
FeedParser API | ||
^^^^^^^^^^^^^^ | ||
The :class:`BytesFeedParser`, imported from the :mod:`email.parser.FeedParser` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. The name of the module is There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Oups, sry for this overlook There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Same for this. It seems like we don't get a doc for There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I suggest we don't suppress links but keep the warnings so to know which objects need to be documented. Suppressing the links is not a good idea here. | ||
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.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.TextIOBase.read` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This is a binary file-like object. ContributorAuthor
| ||
methods. | ||
The bytes contained in *fp* must be formatted as a block of :rfc:`5322` | ||
(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 | ||
Uh oh!
There was an error while loading.Please reload this page.