Logic on streaming responses was changed in 1.0
authorDavid Fischer <djfische@gmail.com>
Sat, 2 Mar 2013 16:44:14 +0000 (08:44 -0800)
committerDavid Fischer <djfische@gmail.com>
Sat, 2 Mar 2013 16:44:14 +0000 (08:44 -0800)
* prefetch=False in 0.x is now stream=True

docs/api.rst

index a3c68a0..2309e93 100644 (file)
@@ -142,12 +142,12 @@ API Changes
 .. _requests-kerberos: https://github.com/requests/requests-kerberos
 
 * The parameter for streaming requests was changed from ``prefetch`` to
-  ``stream``. In addition, the stream parameter is required for raw response
-  reading.
+  ``stream`` and the logic was inverted. In addition, ``stream`` is now
+  required for raw response reading.
 
   ::
 
-      # in 0.x, the "stream" parameter was called "prefetch"
+      # in 0.x, passing prefetch=False would accomplish the same thing
       r = requests.get('https://github.com/timeline.json', stream=True)
       r.raw.read(10)