docs: imaplib: note: Idler objects require 'with'

foresto · Dec 9, 2024 · 92d7ce7 · 92d7ce7
1 parent ae74499
commit 92d7ce7
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst
@@ -389,6 +389,12 @@ An :class:`IMAP4` instance has the following methods:
       advised not to use :meth:`Idler.burst() <imaplib.IMAP4.Idler.burst>`
       with an :class:`IMAP4_stream` connection on Windows.
 
+   .. note::
+
+      The :class:`!Idler` object returned by :meth:`IMAP4.idle` is usable only
+      within a :keyword:`with` statement.  To retrieve unsolicited IMAP
+      responses outside that context, see :meth:`IMAP4.response`.
+
    .. note::
 
       The :class:`!Idler` class name and structure are internal interfaces,