Skip to content

Commit c7ed3c5

Browse files
forestogvanrossum
andauthored
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 <[email protected]>
1 parent 75fbe8e commit c7ed3c5

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Doc/library/imaplib.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
.. changes for IMAP4_SSL by Tino Lange <[email protected]>, March 2002
1111
.. changes for IMAP4_stream by Piers Lauder <[email protected]>,
1212
November 2002
13-
.. changes for IDLE by Forest <[email protected]> August 2024
13+
.. changes for IMAP4 IDLE by Forest <[email protected]> August 2024
1414
1515
**Source code:** :source:`Lib/imaplib.py`
1616

@@ -310,7 +310,7 @@ An :class:`IMAP4` instance has the following methods:
310310

311311
.. method:: IMAP4.idle(dur=None)
312312

313-
Return an :class:`!Idler`: an iterable context manager implementing the ``IDLE``
313+
Return an :class:`!Idler`: an iterable context manager implementing the IMAP4 ``IDLE``
314314
command as defined in :rfc:`2177`.
315315

316316
The context manager sends the ``IDLE`` command when activated by the

Doc/whatsnew/3.14.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ inspect
406406
imaplib
407407
-------
408408

409-
* Add :meth:`~imaplib.IMAP4.idle`, implementing the ``IDLE`` command
409+
* Add :meth:`~imaplib.IMAP4.idle`, implementing the IMAP4 ``IDLE`` command
410410
as defined in :rfc:`2177`. (Contributed by Forest in :gh:`55454`.)
411411

412412
json

0 commit comments

Comments
 (0)