mirror of
https://github.com/python/cpython.git
synced 2025-07-08 20:05:28 +00:00
docs: imaplib: use the reStructuredText :class: role
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
This commit is contained in:
parent
e64546cbae
commit
f385e441df
1 changed files with 2 additions and 2 deletions
|
@ -310,7 +310,7 @@ An :class:`IMAP4` instance has the following methods:
|
||||||
|
|
||||||
.. method:: IMAP4.idle(dur=None)
|
.. method:: IMAP4.idle(dur=None)
|
||||||
|
|
||||||
Return an ``Idler``: an iterable context manager implementing the ``IDLE``
|
Return an :class:`Idler`: an iterable context manager implementing the ``IDLE``
|
||||||
command as defined in :rfc:`2177`.
|
command as defined in :rfc:`2177`.
|
||||||
|
|
||||||
The context manager sends the ``IDLE`` command when activated by the
|
The context manager sends the ``IDLE`` command when activated by the
|
||||||
|
@ -393,7 +393,7 @@ An :class:`IMAP4` instance has the following methods:
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
Note: The ``Idler`` class name and structure are internal interfaces,
|
Note: The :class:`Idler` class name and structure are internal interfaces,
|
||||||
subject to change. Calling code can rely on its context management,
|
subject to change. Calling code can rely on its context management,
|
||||||
iteration, and public method to remain stable, but should not
|
iteration, and public method to remain stable, but should not
|
||||||
subclass, instantiate, or otherwise directly reference the class.
|
subclass, instantiate, or otherwise directly reference the class.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue