From b7a126661175a3b9b73dbb4cb88709868d6d871c Mon Sep 17 00:00:00 2001 From: Nolan Emirot Date: Thu, 3 Feb 2022 17:18:56 -0800 Subject: [PATCH 1/2] docs: add transient errors retry info --- docs/api-usage.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api-usage.rst b/docs/api-usage.rst index 8befc5633..72b02a771 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -423,6 +423,7 @@ python-gitlab can automatically retry in such case, when HTTP error codes 500 (Internal Server Error), 502 (502 Bad Gateway), 503 (Service Unavailable), and 504 (Gateway Timeout) are retried. By default an exception is raised for these errors. +It will retry until reaching `max_retries` value. .. code-block:: python From bb1f05402887c78f9898fbd5bd66e149eff134d9 Mon Sep 17 00:00:00 2001 From: Nolan Emirot Date: Fri, 4 Feb 2022 08:39:44 -0800 Subject: [PATCH 2/2] docs: add retry_transient infos Co-authored-by: Nejc Habjan --- docs/api-usage.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api-usage.rst b/docs/api-usage.rst index 72b02a771..e39082d2b 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -421,9 +421,9 @@ GitLab server can sometimes return a transient HTTP error. python-gitlab can automatically retry in such case, when ``retry_transient_errors`` argument is set to ``True``. When enabled, HTTP error codes 500 (Internal Server Error), 502 (502 Bad Gateway), -503 (Service Unavailable), and 504 (Gateway Timeout) are retried. By -default an exception is raised for these errors. -It will retry until reaching `max_retries` value. +503 (Service Unavailable), and 504 (Gateway Timeout) are retried. It will retry until reaching +the `max_retries` value. By default, `retry_transient_errors` is set to `False` and an exception +is raised for these errors. .. code-block:: python