diff options
author | Antoine Pitrou <solipsis@pitrou.net> | 2011-02-07 16:03:47 (GMT) |
---|---|---|
committer | Antoine Pitrou <solipsis@pitrou.net> | 2011-02-07 16:03:47 (GMT) |
commit | e9bd9dbc7336d3c9816b2f96eb67f1dcb8e1bd28 (patch) | |
tree | ddf96ddb45811924d4e86447eb88de332199c593 | |
parent | e3e967f2b31c2527dae36a1da7a4ec4f8fb07269 (diff) | |
download | cpython-e9bd9dbc7336d3c9816b2f96eb67f1dcb8e1bd28.zip cpython-e9bd9dbc7336d3c9816b2f96eb67f1dcb8e1bd28.tar.gz cpython-e9bd9dbc7336d3c9816b2f96eb67f1dcb8e1bd28.tar.bz2 |
Merged revisions 88371 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88371 | antoine.pitrou | 2011-02-07 16:58:11 +0100 (lun., 07 févr. 2011) | 3 lines
Clarify that IMAP4() implicitly calls open(), and that logout() implicitly calls shutdown().
........
-rw-r--r-- | Doc/library/imaplib.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst index 72ea7e8..fd09041 100644 --- a/Doc/library/imaplib.rst +++ b/Doc/library/imaplib.rst @@ -307,9 +307,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) @@ -405,7 +406,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() |