]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
docs: refer to IMAP4 IDLE instead of just IDLE
authorForest <foresto@users.noreply.github.com>
Sun, 1 Dec 2024 20:03:53 +0000 (20:03 +0000)
committerGitHub <noreply@github.com>
Sun, 1 Dec 2024 20:03:53 +0000 (20:03 +0000)
This clarifies that we are referring to the email protocol, not the editor with the same name.

Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Doc/library/imaplib.rst
Doc/whatsnew/3.14.rst

index ce47db49c150474498aa14c1bca7b6843529e2ea..329b3ce6825b764299ad7b8c882599dc33e2089e 100644 (file)
@@ -10,7 +10,7 @@
 .. changes for IMAP4_SSL by Tino Lange <Tino.Lange@isg.de>, March 2002
 .. changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>,
    November 2002
-.. changes for IDLE by Forest <forestix@nom.one> August 2024
+.. changes for IMAP4 IDLE by Forest <forestix@nom.one> 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
index 6f92ecef4f35034f70133375317eb803804c95cd..302c8407d148ad76607610a1fd334d5609cd8329 100644 (file)
@@ -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