diff options
author | jcgregorio <devnull@localhost> | 2007-03-09 02:30:04 +0000 |
---|---|---|
committer | jcgregorio <devnull@localhost> | 2007-03-09 02:30:04 +0000 |
commit | afc233d509b075080b578b72d4e4bf190d6e7cc9 (patch) | |
tree | ec5d52f773abc4fd425b0d114b3d20767c13c222 | |
parent | b2697911bc71672c126eaa1f7d392d13f3d96e9b (diff) | |
download | httplib2-afc233d509b075080b578b72d4e4bf190d6e7cc9.tar.gz |
Added documentation for Http() level timeout.
-rw-r--r-- | libhttplib2.tex | 3 | ||||
-rw-r--r-- | ref/module-httplib2.html | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/libhttplib2.tex b/libhttplib2.tex index f8b50d7..5b8a16d 100644 --- a/libhttplib2.tex +++ b/libhttplib2.tex @@ -157,11 +157,12 @@ are unfamiliar with. % memberdesc - data members, like datadesc, but with an optional % type name like methoddesc. -\begin{classdesc}{Http}{\optional{cache=None}} +\begin{classdesc}{Http}{\optional{cache=None}, \optional{timeout=None}} The class that represents a client HTTP interface. The \var{cache} parameter is either the name of a directory to be used as a flat file cache, or it must an object that implements the required caching interface. +The \var{timeout} parameter is the socket level timeout. \end{classdesc} \begin{classdesc}{Response}{info} diff --git a/ref/module-httplib2.html b/ref/module-httplib2.html index 137482c..254aaff 100644 --- a/ref/module-httplib2.html +++ b/ref/module-httplib2.html @@ -169,12 +169,13 @@ are unfamiliar with. <P> <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> <td><nobr><b><span class="typelabel">class</span> <tt id='l2h-11' xml:id='l2h-11' class="class">Http</tt></b>(</nobr></td> - <td><var></var><big>[</big><var>cache=None</var><big>]</big><var></var>)</td></tr></table></dt> + <td><var></var><big>[</big><var>cache=None</var><big>]</big><var>, </var><big>[</big><var>timeout=None</var><big>]</big><var></var>)</td></tr></table></dt> <dd> The class that represents a client HTTP interface. The <var>cache</var> parameter is either the name of a directory to be used as a flat file cache, or it must an object that implements the required caching interface. +The <var>timeout</var> parameter is the socket level timeout. </dl> <P> |