Skip to content

Commit 5fe3669

Browse files
committed
Update docstrings
1 parent 83357bf commit 5fe3669

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

src/apify_client/_apify_client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,9 @@ def __init__(
138138
max_retries: How many times to retry a failed request at most.
139139
min_delay_between_retries: How long will the client wait between retrying requests
140140
(increases exponentially from this value).
141-
timeout_short: Timeout for fast CRUD operations (e.g., get, update, delete).
142-
timeout_medium: Timeout for batch, list, and data transfer operations.
143-
timeout_long: Timeout for long-polling, streaming, and other heavy operations.
141+
timeout_short: Default timeout for short-duration API operations (simple CRUD operations, ...).
142+
timeout_medium: Default timeout for medium-duration API operations (batch operations, listing, ...).
143+
timeout_long: Default timeout for long-duration API operations (long-polling, streaming, ...).
144144
timeout_max: Maximum timeout cap for exponential timeout growth across retries.
145145
headers: Additional HTTP headers to include in all API requests.
146146
"""
@@ -491,9 +491,9 @@ def __init__(
491491
max_retries: How many times to retry a failed request at most.
492492
min_delay_between_retries: How long will the client wait between retrying requests
493493
(increases exponentially from this value).
494-
timeout_short: Timeout for fast CRUD operations (e.g., get, update, delete).
495-
timeout_medium: Timeout for batch, list, and data transfer operations.
496-
timeout_long: Timeout for long-polling, streaming, and other heavy operations.
494+
timeout_short: Default timeout for short-duration API operations (simple CRUD operations, ...).
495+
timeout_medium: Default timeout for medium-duration API operations (batch operations, listing, ...).
496+
timeout_long: Default timeout for long-duration API operations (long-polling, streaming, ...).
497497
timeout_max: Maximum timeout cap for exponential timeout growth across retries.
498498
headers: Additional HTTP headers to include in all API requests.
499499
"""

src/apify_client/_http_clients/_base.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ def __init__(
105105
106106
Args:
107107
token: Apify API token for authentication.
108-
timeout_short: Timeout for fast CRUD operations (e.g., get, update, delete).
109-
timeout_medium: Timeout for batch, list, and data transfer operations.
110-
timeout_long: Timeout for long-polling, streaming, and other heavy operations.
108+
timeout_short: Default timeout for short-duration API operations (simple CRUD operations, ...).
109+
timeout_medium: Default timeout for medium-duration API operations (batch operations, listing, ...).
110+
timeout_long: Default timeout for long-duration API operations (long-polling, streaming, ...).
111111
timeout_max: Maximum timeout cap for exponential timeout growth across retries.
112112
max_retries: Maximum number of retries for failed requests.
113113
min_delay_between_retries: Minimum delay between retries.

src/apify_client/_http_clients/_impit.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ def __init__(
7878
7979
Args:
8080
token: Apify API token for authentication.
81-
timeout_short: Timeout for fast CRUD operations (e.g., get, update, delete).
82-
timeout_medium: Timeout for batch, list, and data transfer operations.
83-
timeout_long: Timeout for long-polling, streaming, and other heavy operations.
81+
timeout_short: Default timeout for short-duration API operations (simple CRUD operations, ...).
82+
timeout_medium: Default timeout for medium-duration API operations (batch operations, listing, ...).
83+
timeout_long: Default timeout for long-duration API operations (long-polling, streaming, ...).
8484
timeout_max: Maximum timeout cap for exponential timeout growth across retries.
8585
max_retries: Maximum number of retry attempts for failed requests.
8686
min_delay_between_retries: Minimum delay between retries (increases exponentially with each attempt).
@@ -314,9 +314,9 @@ def __init__(
314314
315315
Args:
316316
token: Apify API token for authentication.
317-
timeout_short: Timeout for fast CRUD operations (e.g., get, update, delete).
318-
timeout_medium: Timeout for batch, list, and data transfer operations.
319-
timeout_long: Timeout for long-polling, streaming, and other heavy operations.
317+
timeout_short: Default timeout for short-duration API operations (simple CRUD operations, ...).
318+
timeout_medium: Default timeout for medium-duration API operations (batch operations, listing, ...).
319+
timeout_long: Default timeout for long-duration API operations (long-polling, streaming, ...).
320320
timeout_max: Maximum timeout cap for exponential timeout growth across retries.
321321
max_retries: Maximum number of retry attempts for failed requests.
322322
min_delay_between_retries: Minimum delay between retries (increases exponentially with each attempt).

0 commit comments

Comments
 (0)