]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.15] gh-149930: Clarify imaplib response helper types (GH-149963) (GH-153123)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 5 Jul 2026 13:27:34 +0000 (15:27 +0200)
committerGitHub <noreply@github.com>
Sun, 5 Jul 2026 13:27:34 +0000 (16:27 +0300)
(cherry picked from commit d2d415b9761a539c37ea4f950df4e9aab0eca6ed)

Co-authored-by: Savage Mechanic <savagemechanic@github.com>
Co-authored-by: savagemechanic <20458938+savagemechanic@users.noreply.github.com>
Doc/library/imaplib.rst

index 38a749b95f3e0e90f0f3d34225c0c6d74db2be60..8992a6cb7c81246a69758db420a6641a6571a20f 100644 (file)
@@ -127,11 +127,11 @@ The second subclass allows for connections created by a child process:
 The following utility functions are defined:
 
 
-.. function:: Internaldate2tuple(datestr)
+.. function:: Internaldate2tuple(resp)
 
-   Parse an IMAP4 ``INTERNALDATE`` string and return corresponding local
-   time.  The return value is a :class:`time.struct_time` tuple or
-   ``None`` if the string has wrong format.
+   Parse a :term:`bytes-like object` containing an IMAP4 ``INTERNALDATE``
+   response and return the corresponding local time.  The return value is a
+   :class:`time.struct_time` tuple or ``None`` if the input has wrong format.
 
 .. function:: Int2AP(num)
 
@@ -139,9 +139,11 @@ The following utility functions are defined:
    [``A`` .. ``P``].
 
 
-.. function:: ParseFlags(flagstr)
+.. function:: ParseFlags(resp)
 
-   Converts an IMAP4 ``FLAGS`` response to a tuple of individual flags.
+   Converts a :term:`bytes-like object` containing an IMAP4 ``FLAGS`` response
+   to a tuple of individual flags as :class:`bytes`.  The return value is an
+   empty tuple if the input has wrong format.
 
 
 .. function:: Time2Internaldate(date_time)