gh-67512: Document IMAP4.append() flags argument#149907
Open
savagemechanic wants to merge 1 commit into
Open
Conversation
|
All commit authors signed the Contributor License Agreement. |
Documentation build overview
|
2cdbe5e to
43ef5ad
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify the type and format expected for the
flagsargument toimaplib.IMAP4.append().The current documentation names the argument but does not explain that it should be an IMAP flag string. This can lead readers to pass a Python tuple or list of flags, which does not match the API. The updated text documents that
flagsmay beNoneor a string of IMAP flag tokens, shows a multi-flag example, and notes that parentheses are added automatically when omitted.Docs-only change.
Testing:
make -C Doc check./Doc/venv/bin/pre-commit run sphinx-lint --files Doc/library/imaplib.rst