]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Revert "docs: imaplib: use the reStructuredText :class: role"
authorForest <forestix@nom.one>
Tue, 24 Sep 2024 19:23:29 +0000 (12:23 -0700)
committerForest <forestix@nom.one>
Tue, 24 Sep 2024 19:23:29 +0000 (12:23 -0700)
This reverts commit f385e441df15d962d1f22e9bab2f15a39e5363d5, because it
triggers CI failures in the docs by referencing a class that is
(deliberately) undocumented.

Doc/library/imaplib.rst

index a8de32ad07a8738616fc35052d395b2cdc7fe23d..6f765bbed1ccf47d1a67e7007d188eb5b0e6d7ee 100644 (file)
@@ -310,7 +310,7 @@ An :class:`IMAP4` instance has the following methods:
 
 .. method:: IMAP4.idle(dur=None)
 
-   Return an :class:`Idler`: an iterable context manager implementing the ``IDLE``
+   Return an ``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 :class:`Idler` class name and structure are internal interfaces,
+      Note: The ``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.