From 4f02c5c04b23e3cf7626c950f25fc43a08d07a63 Mon Sep 17 00:00:00 2001 From: Charly C Date: Mon, 12 Aug 2019 10:55:04 +0200 Subject: [PATCH] clarify what `max_network_retries` does --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index be54ff2b0..6209c55b3 100644 --- a/README.md +++ b/README.md @@ -101,13 +101,16 @@ stripe.proxy = "https://user:pass@example.com:1234" ### Configuring Automatic Retries -Number of automatic retries on requests that fail due to an intermittent -network problem can be configured: +You can enable automatic retries on requests that fail due to a transient +problem by configuring the maximum number of retries: ```python stripe.max_network_retries = 2 ``` +Various errors can trigger a retry, for example a connection error or a timeout, +but also an API response whose HTTP status code is `409`. + [Idempotency keys][idempotency-keys] are automatically generated and added to requests, when not given, to guarantee that retries are safe.