Update documentation about max_retries to reflect code
authorKevin Burke <kev@inburke.com>
Mon, 27 Oct 2014 16:56:18 +0000 (09:56 -0700)
committerKevin Burke <kev@inburke.com>
Mon, 27 Oct 2014 16:56:18 +0000 (09:56 -0700)
HISTORY.rst
requests/adapters.py

index 4e7903dd9d69135fc619f745ffcec713ef98909f..0d0d216d5505a3ef879c63a0a54fb2c9044d1900 100644 (file)
@@ -49,8 +49,6 @@ Release History
 **Behavioral Changes**
 
 - ``Connection: keep-alive`` header is now sent automatically.
-- Read timeout errors will no longer be retried when you create a Session with
-  ``max_retries`` greater than zero.
 
 **Improvements**
 
index abb25d11fdf6187e8109a89a7ee830d58e3c2943..01a5f33827e18cd9b76cb7c79f11ae694d4f0a23 100644 (file)
@@ -60,8 +60,10 @@ class HTTPAdapter(BaseAdapter):
     :param pool_connections: The number of urllib3 connection pools to cache.
     :param pool_maxsize: The maximum number of connections to save in the pool.
     :param int max_retries: The maximum number of retries each connection
-        should attempt. Note, this applies only to failed connections and
-        timeouts, never to requests where the server returns a response.
+        should attempt. Note, this applies only to failed DNS lookups, socket
+        connections and connection timeouts, never to requests where data has
+        made it to the server. By default, Requests does not retry failed
+        connections.
     :param pool_block: Whether the connection pool should block for connections.
 
     Usage::