Skip to content

Commit c8d4d6d

Browse files
committed
docs: imaplib: use the reST :class: role, escaped
This is a different approach to f385e44, which was reverted for creating dangling link references. By prefixing the reStructuredText role target with a ! we disable conversion to a link, thereby passing continuous integration checks even though the referenced class is deliberately absent from the documentation.
1 parent 3aceaec commit c8d4d6d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Doc/library/imaplib.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ An :class:`IMAP4` instance has the following methods:
310310

311311
.. method:: IMAP4.idle(dur=None)
312312

313-
Return an ``Idler``: an iterable context manager implementing the ``IDLE``
313+
Return an :class:`!Idler`: an iterable context manager implementing the ``IDLE``
314314
command as defined in :rfc:`2177`.
315315

316316
The context manager sends the ``IDLE`` command when activated by the
@@ -393,7 +393,7 @@ An :class:`IMAP4` instance has the following methods:
393393

394394
.. note::
395395

396-
Note: The ``Idler`` class name and structure are internal interfaces,
396+
Note: 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)