Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a3f21cd

Browse filesBrowse files
committed
docs: imaplib idle() phrasing and linking tweaks
1 parent b01de95 commit a3f21cd
Copy full SHA for a3f21cd

File tree

1 file changed

+10
-10
lines changed
Filter options

1 file changed

+10
-10
lines changed

‎Doc/library/imaplib.rst

Copy file name to clipboardExpand all lines: Doc/library/imaplib.rst
+10-10Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -313,14 +313,14 @@ An :class:`IMAP4` instance has the following methods:
313313
Return an :class:`!Idler`: an iterable context manager implementing the IMAP4 ``IDLE``
314314
command as defined in :rfc:`2177`.
315315

316-
The context manager sends the ``IDLE`` command when activated by the
316+
The returned object sends the ``IDLE`` command when activated by the
317317
:keyword:`with` statement, produces IMAP untagged responses via the
318318
:term:`iterator` protocol, and sends ``DONE`` upon context exit.
319319

320320
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.
324324
See the :ref:`warning below <windows-pipe-timeout-warning>` if using
325325
:class:`IMAP4_stream` on Windows.
326326

@@ -343,7 +343,7 @@ An :class:`IMAP4` instance has the following methods:
343343
Instead of iterating one response at a time, it is also possible to retrieve
344344
the next response along with any immediately available subsequent responses
345345
(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`
347347
:term:`generator`:
348348

349349
.. method:: Idler.burst(interval=0.1)
@@ -386,14 +386,14 @@ An :class:`IMAP4` instance has the following methods:
386386
inactivity timeouts would make 27 minutes a sensible value for *dur* in
387387
this situation.
388388

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.
393393

394394
.. note::
395395

396-
Note: The :class:`!Idler` class name and structure are internal interfaces,
396+
The :class:`!Idler` class name and structure are internal interfaces,
397397
subject to change. Calling code can rely on its context management,
398398
iteration, and public method to remain stable, but should not
399399
subclass, instantiate, or otherwise directly reference the class.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.