From 6d0315f78fb27ec92407e50694c7054aa16ad1b1 Mon Sep 17 00:00:00 2001 From: Yang Zhang Date: Fri, 6 Sep 2013 19:27:57 -0700 Subject: [PATCH 1/2] 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 32d63388..b77362a2 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 From 2cb523b267df411a97388b147447e75e34880794 Mon Sep 17 00:00:00 2001 From: Yang Zhang Date: Sat, 7 Sep 2013 00:16:09 -0700 Subject: [PATCH 2/2] Fix typo in Timeouts doc --- docs/user/quickstart.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index b77362a2..0eafc62d 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -391,7 +391,7 @@ seconds with the ``timeout`` parameter:: .. admonition:: Note ``timeout`` is not a time limit on the entire response download; - rather, an exception is raised if the server does has not issued a + rather, an exception is raised if the server has not issued a response for ``timeout`` seconds (more precisely, if no bytes have been received on the underlying socket for ``timeout`` seconds).