From f385e441df15d962d1f22e9bab2f15a39e5363d5 Mon Sep 17 00:00:00 2001 From: Forest Date: Tue, 24 Sep 2024 18:30:15 +0000 Subject: [PATCH] docs: imaplib: use the reStructuredText :class: role Co-authored-by: Peter Bierma --- 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 6f765bbed1c..a8de32ad07a 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.