Skip to content

Conversation

Rajendra1308
Copy link

@Rajendra1308 Rajendra1308 commented Dec 27, 2023

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

hugovk
hugovk previously requested changes Dec 27, 2023
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

@@ -204,7 +204,15 @@ An :class:`IMAP4` instance has the following methods:

.. method:: IMAP4.append(mailbox, flags, date_time, message)

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

Copy link
Member

Choose a reason for hiding this comment

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

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

image

So let's delete these bits of trailing whitespace.

@bedevere-app
Copy link

bedevere-app bot commented Dec 27, 2023

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 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
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@Rajendra1308
Copy link
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. :)

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

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

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@Rajendra1308
Copy link
Author

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

@hugovk 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.

* ``\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.
Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link

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

CLA signed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

3 participants