Skip to content
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

Jump to bottom

Fix docstring about BackOffHTTPClient #1502

Merged
merged 1 commit into from
Aug 8, 2024
Merged

Fix docstring about BackOffHTTPClient #1502

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions gspread/http_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ def import_csv(self, file_id: str, data: Union[str, bytes]) -> Any:


class BackOffHTTPClient(HTTPClient):
"""BackoffClient is a gspread client with exponential
"""BackOffHTTPClient is a http client with exponential
backoff retries.

In case a request fails due to some API rate limits,
Expand All @@ -524,12 +524,12 @@ class BackOffHTTPClient(HTTPClient):
prevent the application from failing (by raising an APIError exception).

.. Warning::
This Client is not production ready yet.
This HTTPClient is not production ready yet.
Use it at your own risk !

.. note::
To use with the `auth` module, make sure to pass this backoff
client factory using the ``client_factory`` parameter of the
http client using the ``http_client`` parameter of the
method used.

.. note::
Expand Down