@@ -313,14 +313,14 @@ An :class:`IMAP4` instance has the following methods:
313
313
Return an :class: `!Idler `: an iterable context manager implementing the IMAP4 ``IDLE ``
314
314
command as defined in :rfc: `2177 `.
315
315
316
- The context manager sends the ``IDLE `` command when activated by the
316
+ The returned object sends the ``IDLE `` command when activated by the
317
317
:keyword: `with ` statement, produces IMAP untagged responses via the
318
318
:term: `iterator ` protocol, and sends ``DONE `` upon context exit.
319
319
320
320
The *dur * argument sets a maximum duration (in seconds) to keep idling,
321
- after which iteration will stop. It defaults to ``None ``, meaning no time
322
- limit. Callers wishing to avoid inactivity timeouts on servers that impose
323
- them should keep this at most 29 minutes.
321
+ after which any ongoing iteration will stop. It defaults to ``None ``,
322
+ meaning no time limit. Callers wishing to avoid inactivity timeouts on
323
+ servers that impose them should keep this at most 29 minutes.
324
324
See the :ref: `warning below <windows-pipe-timeout-warning >` if using
325
325
:class: `IMAP4_stream ` on Windows.
326
326
@@ -343,7 +343,7 @@ An :class:`IMAP4` instance has the following methods:
343
343
Instead of iterating one response at a time, it is also possible to retrieve
344
344
the next response along with any immediately available subsequent responses
345
345
(e.g. a rapid series of ``EXPUNGE `` events from a bulk delete). This
346
- batch processing aid is provided by the context's `` burst() ` `
346
+ batch processing aid is provided by the context's :meth: ` Idler. burst `
347
347
:term: `generator `:
348
348
349
349
.. method :: Idler.burst(interval=0.1)
@@ -386,14 +386,14 @@ An :class:`IMAP4` instance has the following methods:
386
386
inactivity timeouts would make 27 minutes a sensible value for *dur * in
387
387
this situation.
388
388
389
- There is no such fallback for `` burst() `` , which will yield endless
390
- responses and block indefinitely for each one. It is therefore advised
391
- not to use `` burst() `` with an :class: `IMAP4_stream ` connection on
392
- Windows.
389
+ There is no such fallback for :meth: ` Idler. burst` , which will yield
390
+ endless responses and block indefinitely for each one. It is therefore
391
+ advised not to use :meth: ` Idler. burst` with an :class: `IMAP4_stream `
392
+ connection on Windows.
393
393
394
394
.. note ::
395
395
396
- Note: The :class: `!Idler ` class name and structure are internal interfaces,
396
+ The :class: `!Idler ` class name and structure are internal interfaces,
397
397
subject to change. Calling code can rely on its context management,
398
398
iteration, and public method to remain stable, but should not
399
399
subclass, instantiate, or otherwise directly reference the class.
0 commit comments