From c7ed3c5cf57a1c7cbb6bb0c6df0b21a7dc5fd5a3 Mon Sep 17 00:00:00 2001 From: Forest Date: Sun, 1 Dec 2024 20:03:53 +0000 Subject: [PATCH] docs: refer to IMAP4 IDLE instead of just IDLE This clarifies that we are referring to the email protocol, not the editor with the same name. Co-authored-by: Guido van Rossum --- Doc/library/imaplib.rst | 4 ++-- Doc/whatsnew/3.14.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst index ce47db49c150..329b3ce6825b 100644 --- a/Doc/library/imaplib.rst +++ b/Doc/library/imaplib.rst @@ -10,7 +10,7 @@ .. changes for IMAP4_SSL by Tino Lange , March 2002 .. changes for IMAP4_stream by Piers Lauder , November 2002 -.. changes for IDLE by Forest August 2024 +.. changes for IMAP4 IDLE by Forest August 2024 **Source code:** :source:`Lib/imaplib.py` @@ -310,7 +310,7 @@ An :class:`IMAP4` instance has the following methods: .. method:: IMAP4.idle(dur=None) - Return an :class:`!Idler`: an iterable context manager implementing the ``IDLE`` + Return an :class:`!Idler`: an iterable context manager implementing the IMAP4 ``IDLE`` command as defined in :rfc:`2177`. The context manager sends the ``IDLE`` command when activated by the diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst index 6f92ecef4f35..302c8407d148 100644 --- a/Doc/whatsnew/3.14.rst +++ b/Doc/whatsnew/3.14.rst @@ -406,7 +406,7 @@ inspect imaplib ------- -* Add :meth:`~imaplib.IMAP4.idle`, implementing the ``IDLE`` command +* Add :meth:`~imaplib.IMAP4.idle`, implementing the IMAP4 ``IDLE`` command as defined in :rfc:`2177`. (Contributed by Forest in :gh:`55454`.) json -- 2.47.3