Merge pull request #2308 from kevinburke/read-timeout-retry

Note about read timeout errors and max_retries

1 files changed, 4 insertions, 2 deletions

diff --git a/requests/adapters.py b/requests/adapters.py
index aae42bd7..40088900 100644
--- a/requests/adapters.py
+++ b/requests/adapters.py
@@ -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::