]> granicus.if.org Git - python/commitdiff
Clarify that IMAP4() implicitly calls open(), and that logout() implicitly calls...
authorAntoine Pitrou <solipsis@pitrou.net>
Mon, 7 Feb 2011 15:58:11 +0000 (15:58 +0000)
committerAntoine Pitrou <solipsis@pitrou.net>
Mon, 7 Feb 2011 15:58:11 +0000 (15:58 +0000)
Doc/library/imaplib.rst

index 78adcf8a5a475fe2bc9ccb5e6c5744773686c2e9..1d92fe53397551aa092b95681eb0660191c77d75 100644 (file)
@@ -298,9 +298,10 @@ An :class:`IMAP4` instance has the following methods:
 
 .. method:: IMAP4.open(host, port)
 
-   Opens socket to *port* at *host*. The connection objects established by this
+   Opens socket to *port* at *host*.  This method is implicitly called by
+   the :class:`IMAP4` constructor.  The connection objects established by this
    method will be used in the ``read``, ``readline``, ``send``, and ``shutdown``
-   methods. You may override this method.
+   methods.  You may override this method.
 
 
 .. method:: IMAP4.partial(message_num, message_part, start, length)
@@ -390,7 +391,8 @@ An :class:`IMAP4` instance has the following methods:
 
 .. method:: IMAP4.shutdown()
 
-   Close connection established in ``open``. You may override this method.
+   Close connection established in ``open``.  This method is implicitly
+   called by :meth:`IMAP4.logout`.  You may override this method.
 
 
 .. method:: IMAP4.socket()