[Python-checkins] r55901 - python/trunk/Doc/lib/libftplib.tex python/trunk/Doc/lib/libhttplib.tex python/trunk/Doc/lib/libpoplib.tex python/trunk/Doc/lib/libsmtplib.tex python/trunk/Doc/lib/libsocket.tex python/trunk/Doc/lib/libtelnetlib.tex python/trunk/Doc/lib/liburllib2.tex

facundo.batista python-checkins at python.org
Mon Jun 11 18:27:16 CEST 2007


Author: facundo.batista
Date: Mon Jun 11 18:27:08 2007
New Revision: 55901

Modified:
   python/trunk/Doc/lib/libftplib.tex
   python/trunk/Doc/lib/libhttplib.tex
   python/trunk/Doc/lib/libpoplib.tex
   python/trunk/Doc/lib/libsmtplib.tex
   python/trunk/Doc/lib/libsocket.tex
   python/trunk/Doc/lib/libtelnetlib.tex
   python/trunk/Doc/lib/liburllib2.tex
Log:

Added versionchanged flag to all the methods which received
a new optional timeout parameter, and a versionadded flag to 
the socket.create_connection function.


Modified: python/trunk/Doc/lib/libftplib.tex
==============================================================================
--- python/trunk/Doc/lib/libftplib.tex	(original)
+++ python/trunk/Doc/lib/libftplib.tex	Mon Jun 11 18:27:08 2007
@@ -46,6 +46,7 @@
 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 @@
 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}{}

Modified: python/trunk/Doc/lib/libhttplib.tex
==============================================================================
--- python/trunk/Doc/lib/libhttplib.tex	(original)
+++ python/trunk/Doc/lib/libhttplib.tex	Mon Jun 11 18:27:08 2007
@@ -49,6 +49,7 @@
 >>> 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 @@
 \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}}

Modified: python/trunk/Doc/lib/libpoplib.tex
==============================================================================
--- python/trunk/Doc/lib/libpoplib.tex	(original)
+++ python/trunk/Doc/lib/libpoplib.tex	Mon Jun 11 18:27:08 2007
@@ -35,6 +35,8 @@
 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}}}}

Modified: python/trunk/Doc/lib/libsmtplib.tex
==============================================================================
--- python/trunk/Doc/lib/libsmtplib.tex	(original)
+++ python/trunk/Doc/lib/libsmtplib.tex	Mon Jun 11 18:27:08 2007
@@ -29,6 +29,8 @@
 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 @@
 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{,

Modified: python/trunk/Doc/lib/libsocket.tex
==============================================================================
--- python/trunk/Doc/lib/libsocket.tex	(original)
+++ python/trunk/Doc/lib/libsocket.tex	Mon Jun 11 18:27:08 2007
@@ -177,6 +177,7 @@
 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{,

Modified: python/trunk/Doc/lib/libtelnetlib.tex
==============================================================================
--- python/trunk/Doc/lib/libtelnetlib.tex	(original)
+++ python/trunk/Doc/lib/libtelnetlib.tex	Mon Jun 11 18:27:08 2007
@@ -40,6 +40,7 @@
 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 @@
 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}}

Modified: python/trunk/Doc/lib/liburllib2.tex
==============================================================================
--- python/trunk/Doc/lib/liburllib2.tex	(original)
+++ python/trunk/Doc/lib/liburllib2.tex	Mon Jun 11 18:27:08 2007
@@ -45,6 +45,8 @@
 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 @@
 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{,


More information about the Python-checkins mailing list