From c8d4d6d994e0bbb5406100eabbfea9199037182d Mon Sep 17 00:00:00 2001 From: Forest Date: Thu, 26 Sep 2024 12:02:44 -0700 Subject: [PATCH] docs: imaplib: use the reST :class: role, escaped 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 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst index 6f765bbed1cc..ce47db49c150 100644 --- a/Doc/library/imaplib.rst +++ b/Doc/library/imaplib.rst @@ -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. -- 2.47.3