From: Gregory P. Smith <greg@krypto.org>
Date: Sat, 21 Sep 2024 17:47:50 +0000 (-0700)
Subject: comment -> docstring
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5ef5bb2dcb0db52a8bdf4f30708f44cf59695546;p=thirdparty%2FPython%2Fcpython.git

comment -> docstring

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
---

diff --git a/Lib/imaplib.py b/Lib/imaplib.py
index 7bcbe4912191..0ccb220868c9 100644
--- a/Lib/imaplib.py
+++ b/Lib/imaplib.py
@@ -1472,17 +1472,17 @@ class _Idler:
             return bool(readables)
 
     def _pop(self, timeout, default=('', None)):
-        # Get the next response, or a default value on timeout
-        #
-        # :param timeout:   Time limit (in seconds) to wait for response
-        # :type timeout:    int|float|None
-        # :param default:   Value to return on timeout
-        #
-        # Note: This method ignores 'dur' in favor of the timeout argument.
-        #
-        # Note: Windows IMAP4_stream connections will ignore the timeout
-        # argument and block until the next response arrives, because
-        # Windows select() only works on sockets.
+        """Get the next response, or a default value on timeout
+
+        :param timeout:   Time limit (in seconds) to wait for response
+        :type timeout:    int|float|None
+        :param default:   Value to return on timeout
+
+        Note: This method ignores 'dur' in favor of the timeout argument.
+
+        Note: Windows IMAP4_stream connections will ignore the timeout
+        argument and block until the next response arrives, because
+        Windows select() only works on sockets."""
 
         imap = self._imap
         if imap.state != 'IDLING':