Skip to content

docs: add transient errors retry info #1876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nejch merged 2 commits into from
Feb 4, 2022
Merged

docs: add transient errors retry info #1876

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7a1266
docs: add transient errors retry info
emirot Feb 4, 2022
bb1f054
docs: add retry_transient infos
emirot Feb 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/api-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down