Merge pull request #1876 from emirot/patch-1

docs: add transient errors retry info
python-gitlab · Feb 4, 2022 · 9897c98 · 9897c98
2 parents 2fea2e6 + bb1f054
commit 9897c98
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -421,8 +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.
+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