Skip to content

Commit bdde943

Browse files
author
Forest
committed
docs: imaplib: state duration/interval arg types
1 parent 2e3e956 commit bdde943

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

Doc/library/imaplib.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -322,8 +322,9 @@ An :class:`IMAP4` instance has the following methods:
322322

323323
The *duration* argument sets a maximum duration (in seconds) to keep idling,
324324
after which any ongoing iteration will stop. It defaults to ``None``,
325-
meaning no time limit. Callers wishing to avoid inactivity timeouts on
326-
servers that impose them should keep this at most 29 minutes.
325+
meaning no time limit, but can also be an :class:`int` or :class:`float`.
326+
Callers wishing to avoid inactivity timeouts on servers that impose them
327+
should keep this at most 29 minutes.
327328
See the :ref:`warning below <windows-pipe-timeout-warning>` if using
328329
:class:`IMAP4_stream` on Windows.
329330

@@ -344,7 +345,8 @@ An :class:`IMAP4` instance has the following methods:
344345

345346
.. method:: Idler.burst(interval=0.1)
346347

347-
Yield a burst of responses no more than *interval* seconds apart.
348+
Yield a burst of responses no more than *interval* seconds apart
349+
(expressed as an :class:`int` or :class:`float`).
348350

349351
Example::
350352

0 commit comments

Comments
 (0)