summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorFacundo Batista <facundobatista@gmail.com>2007-03-30 13:00:35 (GMT)
committerFacundo Batista <facundobatista@gmail.com>2007-03-30 13:00:35 (GMT)
commit93c33680a031a5b2b11aaebe0f6dcc1b803f7be1 (patch)
tree561f3827481530171cbe5590e5b715af5b61bf11 /Doc/lib
parentb6a5c9d605588e962f1cd242d2a52065f4c141db (diff)
downloadcpython-93c33680a031a5b2b11aaebe0f6dcc1b803f7be1.zip
cpython-93c33680a031a5b2b11aaebe0f6dcc1b803f7be1.tar.gz
cpython-93c33680a031a5b2b11aaebe0f6dcc1b803f7be1.tar.bz2
Added the posibility to pass the timeout to FTP.connect, not only when
instantiating the class. Docs and tests are updated.
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libftplib.tex8
1 files changed, 7 insertions, 1 deletions
diff --git a/Doc/lib/libftplib.tex b/Doc/lib/libftplib.tex
index bf87481..38b7bc8 100644
--- a/Doc/lib/libftplib.tex
+++ b/Doc/lib/libftplib.tex
@@ -104,13 +104,19 @@ debugging output, generally a single line per request. A value of
logging each line sent and received on the control connection.
\end{methoddesc}
-\begin{methoddesc}{connect}{host\optional{, port}}
+\begin{methoddesc}{connect}{host\optional{, port\optional{, timeout}}}
Connect to the given host and port. The default port number is \code{21}, as
specified by the FTP protocol specification. It is rarely needed to
specify a different port number. This function should be called only
once for each instance; it should not be called at all if a host was
given when the instance was created. All other methods can only be
used after a connection has been made.
+
+The optional \var{timeout} parameter specifies a timeout in seconds for
+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.
\end{methoddesc}
\begin{methoddesc}{getwelcome}{}