[Python-checkins] cpython (2.7): #20903: clarify what happens when an smtp connection timeout occurs.

[r.david.murray]

http://hg.python.org/cpython/rev/6cd64ef6fc95
changeset:   91106:6cd64ef6fc95
branch:      2.7
parent:      91103:1e30ecbfe181
user:        R David Murray <rdmurray at bitdance.com>
date:        Mon Jun 09 16:40:47 2014 -0400
summary:
  #20903: clarify what happens when an smtp connection timeout occurs.

Patch by Milan Oberkirch.

files:
  Doc/library/smtplib.rst |  6 ++++--
  1 files changed, 4 insertions(+), 2 deletions(-)


diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst
--- a/Doc/library/smtplib.rst
+++ b/Doc/library/smtplib.rst
@@ -32,7 +32,8 @@
    than a success code, an :exc:`SMTPConnectError` is raised. The optional
    *timeout* parameter specifies a timeout in seconds for blocking operations
    like the connection attempt (if not specified, the global default timeout
-   setting will be used).
+   setting will be used).  If the timeout expires, :exc:`socket.timeout`
+   is raised.
 
    For normal use, you should only require the initialization/connect,
    :meth:`sendmail`, and :meth:`~smtplib.quit` methods.
@@ -54,7 +55,8 @@
    formatted private key and certificate chain file for the SSL connection. The
    optional *timeout* parameter specifies a timeout in seconds for blocking
    operations like the connection attempt (if not specified, the global default
-   timeout setting will be used).
+   timeout setting will be used).  If the timeout expires, :exc:`socket.timeout`
+   is raised.
 
    .. versionadded:: 2.6
 

-- 
Repository URL: http://hg.python.org/cpython