]> granicus.if.org Git - python/commitdiff
Added versionchanged flag to all the methods which received
authorFacundo Batista <facundobatista@gmail.com>
Mon, 11 Jun 2007 16:27:08 +0000 (16:27 +0000)
committerFacundo Batista <facundobatista@gmail.com>
Mon, 11 Jun 2007 16:27:08 +0000 (16:27 +0000)
a new optional timeout parameter, and a versionadded flag to
the socket.create_connection function.

Doc/lib/libftplib.tex
Doc/lib/libhttplib.tex
Doc/lib/libpoplib.tex
Doc/lib/libsmtplib.tex
Doc/lib/libsocket.tex
Doc/lib/libtelnetlib.tex
Doc/lib/liburllib2.tex

index 98d7e80a4cbb22ae5fc77f95aa4757c83a548f38..1ce5f9bab36a3ba3473957ce9b23c6282625ebb3 100644 (file)
@@ -46,6 +46,7 @@ made.  When \var{user} is given, additionally the method call
 The optional \var{timeout} parameter specifies a timeout in seconds for the
 connection attempt (if is not specified, or passed as None, the global
 default timeout setting will be used).
+\versionchanged[\var{timeout} was added]{2.6}
 \end{classdesc}
 
 \begin{datadesc}{all_errors}
@@ -117,6 +118,8 @@ the connection attempt. If is not specified, or passed as None, the
 object timeout is used (the timeout that you passed when instantiating the
 class); if the object timeout is also None, the global default timeout 
 setting will be used.
+
+\versionchanged[\var{timeout} was added]{2.6}
 \end{methoddesc}
 
 \begin{methoddesc}[FTP]{getwelcome}{}
index 7c9449de174ca2e7d66f15c1e54955c99781ca61..37a442d73ca0facbea37bfee0eabd5bba02fb86f 100644 (file)
@@ -49,6 +49,7 @@ the server at the same host and port:
 >>> h3 = httplib.HTTPConnection('www.cwi.nl', 80, timeout=10)
 \end{verbatim}
 \versionadded{2.0}
+\versionchanged[\var{timeout} was added]{2.6}
 \end{classdesc}
 
 \begin{classdesc}{HTTPSConnection}{host\optional{, port\optional{,
@@ -63,6 +64,7 @@ key. \var{cert_file} is a PEM formatted certificate chain file.
 \warning{This does not do any certificate verification!}
 
 \versionadded{2.0}
+\versionchanged[\var{timeout} was added]{2.6}
 \end{classdesc}
 
 \begin{classdesc}{HTTPResponse}{sock\optional{, debuglevel=0}\optional{, strict=0}}
index 7b2c4a10eb1e3074a0fc0064ad64edef01732f18..9ca5bbd7f2569454aedc7d71e49ec4c279aa587b 100644 (file)
@@ -35,6 +35,8 @@ If \var{port} is omitted, the standard POP3 port (110) is used.
 The optional \var{timeout} parameter specifies a timeout in seconds for the
 connection attempt (if not specified, or passed as None, the global default
 timeout setting will be used).
+
+\versionchanged[\var{timeout} was added]{2.6}
 \end{classdesc}
 
 \begin{classdesc}{POP3_SSL}{host\optional{, port\optional{, keyfile\optional{, certfile}}}}
index dfe85754cf5c93e543e48cbec4064fb6d521a411..370b7cebc54f3f991b393bef5df79bfc34b427ef 100644 (file)
@@ -29,6 +29,8 @@ default timeout setting will be used).
 For normal use, you should only require the initialization/connect,
 \method{sendmail()}, and \method{quit()} methods.  An example is
 included below.
+
+\versionchanged[\var{timeout} was added]{2.6}
 \end{classdesc}
 
 \begin{classdesc}{SMTP_SSL}{\optional{host\optional{, port\optional{,
@@ -45,6 +47,8 @@ certificate chain file for the SSL connection.
 The optional \var{timeout} parameter specifies a timeout in seconds for the
 connection attempt (if not specified, or passed as None, the global
 default timeout setting will be used).
+
+\versionchanged[\var{timeout} was added]{2.6}
 \end{classdesc}
 
 \begin{classdesc}{LMTP}{\optional{host\optional{, port\optional{,
index 99c629ac2d7d60d28092763c365d0c21fa83061a..d9b3b79627c748e2388cedaaecb95afac154d89b 100644 (file)
@@ -177,6 +177,7 @@ higher-level protocols, it is not normally used directly from
 application-level code.  Passing the optional \var{timeout} parameter
 will set the timeout on the socket instance (if it is not given or
 \code{None}, the global default timeout setting is used).
+\versionadded{2.6}
 \end{funcdesc}
 
 \begin{funcdesc}{getaddrinfo}{host, port\optional{, family\optional{,
index 0c51a09c243f145e2732107f0c5faa50d0b29691..5b32a5f167fc5c869e78e28974f8c6df1c7a0d48 100644 (file)
@@ -40,6 +40,7 @@ This class has many \method{read_*()} methods.  Note that some of them
 raise \exception{EOFError} when the end of the connection is read,
 because they can return an empty string for other reasons.  See the
 individual descriptions below.
+\versionchanged[\var{timeout} was added]{2.6}
 \end{classdesc}
 
 
@@ -123,6 +124,7 @@ connection attempt (if not specified, or passed as None, the global default
 timeout setting will be used).
 
 Do not try to reopen an already connected instance.
+\versionchanged[\var{timeout} was added]{2.6}
 \end{methoddesc}
 
 \begin{methoddesc}[Telnet]{msg}{msg\optional{, *args}}
index 5547b1510feb59ac49ced10a58b254eed73bcf7b..9d2c38279e2b9e2f9adebff887782f3d8970c197 100644 (file)
@@ -45,6 +45,8 @@ Raises \exception{URLError} on errors.
 Note that \code{None} may be returned if no handler handles the
 request (though the default installed global \class{OpenerDirector}
 uses \class{UnknownHandler} to ensure this never happens).
+
+\versionchanged[\var{timeout} was added]{2.6}
 \end{funcdesc}
 
 \begin{funcdesc}{install_opener}{opener}
@@ -367,6 +369,7 @@ attempt (if not specified, or passed as None, the global default timeout
 setting will be used; this actually only work for HTTP, HTTPS, FTP
 and FTPS connections).
 
+\versionchanged[\var{timeout} was added]{2.6}
 \end{methoddesc}
 
 \begin{methoddesc}[OpenerDirector]{error}{proto\optional{,