FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-67512: Document parameters of imaplib's append by Rajendra1308 · Pull Request #113506 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-67512: Document parameters of imaplib's append - #113506

Closed
Rajendra1308 wants to merge 6 commits into
python:mainfrom
Rajendra1308:imaplib-append
ConversationCommits (6)ChecksFiles changed
Closed

gh-67512: Document parameters of imaplib's append#113506
Rajendra1308 wants to merge 6 commits into
python:mainfrom
Rajendra1308:imaplib-append

Conversation

Rajendra1308 commented Dec 27, 2023 •
edited by hugovk
Loading

Copy link
Copy Markdown

The IMAP4.append() method was not properly documented which led to various issues in terms of proper usage of the functions. This change solved the #67512

📚 Documentation preview 📚: https://cpython-previews--113506.org.readthedocs.build/en/113506/library/imaplib.html#imaplib.IMAP4.append

Rajendra1308 requested a review from a team as a code owner December 27, 2023 02:30
bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Dec 27, 2023
bedevere-app Bot mentioned this pull request Dec 27, 2023
Closed
hugovk previously requested changes Dec 27, 2023
View reviewed changes

hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Tip: you can add these suggestions to a batch and commit them all at once. See:

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request#applying-suggested-changes

Comment thread Doc/library/imaplib.rst Outdated

Append *message* to named mailbox.
Append *message* to a specified mailbox.

hugovk Dec 27, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

If you click "Details" next to the failed lint check, you'll see a "trim trailing whitespace" check failed:

So let's delete these bits of trailing whitespace.

Comment thread Doc/library/imaplib.rst Outdated
Comment thread Doc/library/imaplib.rst Outdated
Comment thread Doc/library/imaplib.rst Outdated
Comment thread Doc/library/imaplib.rst Outdated
Comment thread Doc/library/imaplib.rst Outdated

bedevere-app Bot commented Dec 27, 2023

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

hugovk mentioned this pull request Dec 27, 2023
Closed
hugovk changed the title gh-67512 imaplib-append method documented gh-67512: Document parameters of imaplib's append Dec 27, 2023
Rajendra1308 and others added 3 commits December 27, 2023 11:17
Apply suggestions from code review
15f2bdd 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
formatted-changes
64a0fc9
white-spaces-removed
c3b76a3

Rajendra1308 commented Dec 27, 2023

Copy link
Copy Markdown
Author

Hey @hugovk, I have made the changes according to the suggestions, also for the format of data_time, whenever I come across new stuff I try to learn it through books or ChatGPT but I guess the latter fails to get correct information sometimes. Thanks for pointing out the error, will keep it in mind in future. :)

hugovk reviewed Dec 27, 2023
View reviewed changes

hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Yep, we have to be careful with ChatGPT, it can invent things. Books should be more trustworthy, unless they're written by LLMs!

Comment thread Doc/library/imaplib.rst Outdated
Apply suggestions from code review
3359ffd 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Rajendra1308 commented Dec 28, 2023

Copy link
Copy Markdown
Author

Hey @hugovk, I think the branch is now ready for merge. Let me know if not!

hugovk dismissed their stale review December 28, 2023 17:21

Thank you for the update! Looks good now, I'll leave it to a subject matter expert from the email-team to give it a final review and merge.

vadmium reviewed Apr 19, 2024
View reviewed changes
Comment thread Doc/library/imaplib.rst
* ``\Flagged`` - Message is "flagged" for urgent/special attention.
* ``\Deleted`` - Message is "deleted" for removal by later ``EXPUNGE``.
* ``\Draft`` - Message has not completed composition (marked as a draft).
* ``\Recent`` - Message is "recently" arrived in this mailbox.

vadmium Apr 19, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

The \Recent flag is supposed to be managed automatically by the server. It seems misleading to list it under the append method.

python-cla-bot Bot commented Apr 18, 2025

Copy link
Copy Markdown

The following commit authors need to sign the Contributor License Agreement:

github-actions Bot commented Apr 15, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 15, 2026

hugovk commented Apr 15, 2026

Copy link
Copy Markdown
Member

Closing because the CLA has not been signed.

hugovk closed this Apr 15, 2026
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

vadmium vadmium left review comments
hugovk hugovk left review comments

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip news stale Stale PR or inactive for long period of time.

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL