Skip to content

Commit 5682ef4

Browse files
author
Forest
committed
docs: imaplib: mark a paragraph as a 'tip'
1 parent 171ebf1 commit 5682ef4

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

Doc/library/imaplib.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -360,11 +360,13 @@ An :class:`IMAP4` instance has the following methods:
360360
processing 3 responses...
361361
[('EXPUNGE', [b'2']), ('EXPUNGE', [b'1']), ('RECENT', [b'0'])]
362362

363-
The ``IDLE`` context's maximum duration, as passed to :meth:`IMAP4.idle`,
364-
is respected when waiting for the first response in a burst.
365-
Therefore, an expired :class:`!Idler` will cause this generator
366-
to return immediately without producing anything. Callers should
367-
consider this if using it in a loop.
363+
.. tip::
364+
365+
The ``IDLE`` context's maximum duration, as passed to
366+
:meth:`IMAP4.idle`, is respected when waiting for the first response
367+
in a burst. Therefore, an expired :class:`!Idler` will cause this
368+
generator to return immediately without producing anything. Callers
369+
should consider this if using it in a loop.
368370

369371

370372
.. _windows-pipe-timeout-warning:

Lib/imaplib.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1570,7 +1570,7 @@ def burst(self, interval=0.1):
15701570
processing 3 responses...
15711571
[('EXPUNGE', [b'2']), ('EXPUNGE', [b'1']), ('RECENT', [b'0'])]
15721572
1573-
The IDLE context's maximum duration, as passed to IMAP4.idle(),
1573+
Tip: The IDLE context's maximum duration, as passed to IMAP4.idle(),
15741574
is respected when waiting for the first response in a burst.
15751575
Therefore, an expired Idler will cause this generator to return
15761576
immediately without producing anything. Callers should consider

0 commit comments

Comments
 (0)