Clarify timeout behavior in quickstart doc
authorYang Zhang <yaaang@gmail.com>
Sat, 7 Sep 2013 02:27:57 +0000 (19:27 -0700)
committerYang Zhang <yaaang@gmail.com>
Sat, 7 Sep 2013 02:27:57 +0000 (19:27 -0700)
docs/user/quickstart.rst

index 32d6338..b77362a 100644 (file)
@@ -390,8 +390,10 @@ seconds with the ``timeout`` parameter::
 
 .. admonition:: Note
 
-    ``timeout`` only affects the connection process itself, not the
-    downloading of the response body.
+    ``timeout`` is not a time limit on the entire response download;
+    rather, an exception is raised if the server does has not issued a
+    response for ``timeout`` seconds (more precisely, if no bytes have been
+    received on the underlying socket for ``timeout`` seconds).
 
 
 Errors and Exceptions