diff options
| author | Nolan Emirot <emirot.nolan@gmail.com> | 2022-02-04 08:39:44 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-04 08:39:44 -0800 |
| commit | bb1f05402887c78f9898fbd5bd66e149eff134d9 (patch) | |
| tree | 38963d3b8967db1c82cd6202fad4617c43550341 /docs/api-usage.rst | |
| parent | b7a126661175a3b9b73dbb4cb88709868d6d871c (diff) | |
| download | gitlab-bb1f05402887c78f9898fbd5bd66e149eff134d9.tar.gz | |
docs: add retry_transient infos
Co-authored-by: Nejc Habjan <hab.nejc@gmail.com>
Diffstat (limited to 'docs/api-usage.rst')
| -rw-r--r-- | docs/api-usage.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst index 72b02a7..e39082d 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 |