Timeout documentation changes.
authorCory Benfield <lukasaoz@gmail.com>
Mon, 3 Mar 2014 20:23:59 +0000 (20:23 +0000)
committerCory Benfield <lukasaoz@gmail.com>
Mon, 3 Mar 2014 20:23:59 +0000 (20:23 +0000)
HISTORY.rst
docs/api.rst

index 9625b95c97b9bcb87d1088e3ff0d01e72b7192a3..19c2ff1bc635acc61ff8b32a8a221ad2db40a9ac 100644 (file)
@@ -11,6 +11,8 @@ Release History
 - New ``Response`` property ``is_redirect``, which is true when the
   library could have processed this response as a redirection (whether
   or not it actually did).
+- The ``timeout`` parameter now affects requests with both ``stream=True`` and
+  ``stream=False`` equally.
 
 2.2.1 (2014-01-23)
 ++++++++++++++++++
index 77f1f02d58796664740bdba9d3f6b8f012bbfd2e..86061be92143f7f9c8f63f1fec6ee010017a4e52 100644 (file)
@@ -249,7 +249,9 @@ Behavioral Changes
 
 * Timeouts behave slightly differently. On streaming requests, the timeout
   only applies to the connection attempt. On regular requests, the timeout
-  is applied to the connection process and downloading the full body.
+  is applied to the connection process and on to all attempts to read data from
+  the underlying socket. It does *not* apply to the total download time for the
+  request.
 
   ::