From a703e24573d46871f5cd63631e33778281981f24 Mon Sep 17 00:00:00 2001 From: Kevin Burke Date: Mon, 27 Oct 2014 09:56:18 -0700 Subject: [PATCH] Update documentation about max_retries to reflect code --- HISTORY.rst | 2 -- requests/adapters.py | 6 ++++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index 4e7903dd..0d0d216d 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -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** diff --git a/requests/adapters.py b/requests/adapters.py index abb25d11..01a5f338 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::