From 6d0315f78fb27ec92407e50694c7054aa16ad1b1 Mon Sep 17 00:00:00 2001 From: Yang Zhang Date: Fri, 6 Sep 2013 19:27:57 -0700 Subject: [PATCH] Clarify timeout behavior in quickstart doc --- docs/user/quickstart.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index 32d6338..b77362a 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -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 -- 2.7.4