]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
docs: imaplib: use the reST :class: role, escaped
authorForest <forestix@nom.one>
Thu, 26 Sep 2024 19:02:44 +0000 (12:02 -0700)
committerForest <forestix@nom.one>
Thu, 26 Sep 2024 19:20:11 +0000 (12:20 -0700)
This is a different approach to f385e441df15, 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.

Doc/library/imaplib.rst

index 6f765bbed1ccf47d1a67e7007d188eb5b0e6d7ee..ce47db49c150474498aa14c1bca7b6843529e2ea 100644 (file)
@@ -310,7 +310,7 @@ An :class:`IMAP4` instance has the following methods:
 
 .. 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`.
 
    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: 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,
       iteration, and public method to remain stable, but should not
       subclass, instantiate, or otherwise directly reference the class.