Skip to content

Commit 9653d95

Browse files
vdusekclaude
vdusek
and
claude
committed
docs: Improve timeout parameter description in docstrings
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a73aae1 commit 9653d95

27 files changed

+227
-227
lines changed

‎src/apify_client/_resource_clients/actor.py‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ def get(self, *, timeout: timedelta | None = None) -> Actor | None:
9292
https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor
9393
9494
Args:
95-
timeout: Timeout for the HTTP request.
95+
timeout: Timeout for the API HTTP request.
9696
9797
Returns:
9898
The retrieved Actor.
@@ -169,7 +169,7 @@ def update(
169169
tagged_builds: A dictionary mapping build tag names to their settings. Use it to create, update,
170170
or remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,
171171
set its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.
172-
timeout: Timeout for the HTTP request.
172+
timeout: Timeout for the API HTTP request.
173173
174174
Returns:
175175
The updated Actor.
@@ -216,7 +216,7 @@ def delete(self, *, timeout: timedelta | None = None) -> None:
216216
https://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor
217217
218218
Args:
219-
timeout: Timeout for the HTTP request.
219+
timeout: Timeout for the API HTTP request.
220220
"""
221221
self._delete(timeout=timeout)
222222

@@ -265,7 +265,7 @@ def start(
265265
* `event_types`: List of `WebhookEventType` values which trigger the webhook.
266266
* `request_url`: URL to which to send the webhook HTTP request.
267267
* `payload_template`: Optional template for the request payload.
268-
timeout: Timeout for the HTTP request.
268+
timeout: Timeout for the API HTTP request.
269269
270270
Returns:
271271
The run object.
@@ -344,7 +344,7 @@ def call(
344344
default logger will be used. Setting `None` will disable any log propagation. Passing custom logger
345345
will redirect logs to the provided logger. The logger is also used to capture status and status message
346346
of the other Actor run.
347-
timeout: Timeout for the HTTP request.
347+
timeout: Timeout for the API HTTP request.
348348
349349
Returns:
350350
The run object.
@@ -404,7 +404,7 @@ def build(
404404
This is to enable quick rebuild during development. By default, the cache is not used.
405405
wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.
406406
By default it is 0, the maximum value is 60.
407-
timeout: Timeout for the HTTP request.
407+
timeout: Timeout for the API HTTP request.
408408
409409
Returns:
410410
The build object.
@@ -454,7 +454,7 @@ def default_build(
454454
Args:
455455
wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.
456456
By default it is 0, the maximum value is 60.
457-
timeout: Timeout for the HTTP request.
457+
timeout: Timeout for the API HTTP request.
458458
459459
Returns:
460460
The resource client for the default build of this Actor.
@@ -539,7 +539,7 @@ def validate_input(
539539
run_input: The input to validate.
540540
build_tag: The Actor's build tag.
541541
content_type: The content type of the input.
542-
timeout: Timeout for the HTTP request.
542+
timeout: Timeout for the API HTTP request.
543543
544544
Returns:
545545
True if the input is valid, else raise an exception with validation error details.
@@ -585,7 +585,7 @@ async def get(self, *, timeout: timedelta | None = None) -> Actor | None:
585585
https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor
586586
587587
Args:
588-
timeout: Timeout for the HTTP request.
588+
timeout: Timeout for the API HTTP request.
589589
590590
Returns:
591591
The retrieved Actor.
@@ -662,7 +662,7 @@ async def update(
662662
tagged_builds: A dictionary mapping build tag names to their settings. Use it to create, update,
663663
or remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,
664664
set its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.
665-
timeout: Timeout for the HTTP request.
665+
timeout: Timeout for the API HTTP request.
666666
667667
Returns:
668668
The updated Actor.
@@ -709,7 +709,7 @@ async def delete(self, *, timeout: timedelta | None = None) -> None:
709709
https://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor
710710
711711
Args:
712-
timeout: Timeout for the HTTP request.
712+
timeout: Timeout for the API HTTP request.
713713
"""
714714
await self._delete(timeout=timeout)
715715

@@ -758,7 +758,7 @@ async def start(
758758
* `event_types`: List of `WebhookEventType` values which trigger the webhook.
759759
* `request_url`: URL to which to send the webhook HTTP request.
760760
* `payload_template`: Optional template for the request payload.
761-
timeout: Timeout for the HTTP request.
761+
timeout: Timeout for the API HTTP request.
762762
763763
Returns:
764764
The run object.
@@ -837,7 +837,7 @@ async def call(
837837
default logger will be used. Setting `None` will disable any log propagation. Passing custom logger
838838
will redirect logs to the provided logger. The logger is also used to capture status and status message
839839
of the other Actor run.
840-
timeout: Timeout for the HTTP request.
840+
timeout: Timeout for the API HTTP request.
841841
842842
Returns:
843843
The run object.
@@ -901,7 +901,7 @@ async def build(
901901
This is to enable quick rebuild during development. By default, the cache is not used.
902902
wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.
903903
By default it is 0, the maximum value is 60.
904-
timeout: Timeout for the HTTP request.
904+
timeout: Timeout for the API HTTP request.
905905
906906
Returns:
907907
The build object.
@@ -951,7 +951,7 @@ async def default_build(
951951
Args:
952952
wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.
953953
By default it is 0, the maximum value is 60.
954-
timeout: Timeout for the HTTP request.
954+
timeout: Timeout for the API HTTP request.
955955
956956
Returns:
957957
The resource client for the default build of this Actor.
@@ -1039,7 +1039,7 @@ async def validate_input(
10391039
run_input: The input to validate.
10401040
build_tag: The Actor's build tag.
10411041
content_type: The content type of the input.
1042-
timeout: Timeout for the HTTP request.
1042+
timeout: Timeout for the API HTTP request.
10431043
10441044
Returns:
10451045
True if the input is valid, else raise an exception with validation error details.

‎src/apify_client/_resource_clients/actor_collection.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def list(
5959
offset: What Actor to include as first when retrieving the list.
6060
desc: Whether to sort the Actors in descending order based on their creation date.
6161
sort_by: Field to sort the results by.
62-
timeout: Timeout for the HTTP request.
62+
timeout: Timeout for the API HTTP request.
6363
6464
Returns:
6565
The list of available Actors matching the specified filters.
@@ -126,7 +126,7 @@ def create(
126126
it will be shut down.
127127
actor_standby_build: The build tag or number to run when the Actor is in Standby mode.
128128
actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.
129-
timeout: Timeout for the HTTP request.
129+
timeout: Timeout for the API HTTP request.
130130
131131
Returns:
132132
The created Actor.
@@ -204,7 +204,7 @@ async def list(
204204
offset: What Actor to include as first when retrieving the list.
205205
desc: Whether to sort the Actors in descending order based on their creation date.
206206
sort_by: Field to sort the results by.
207-
timeout: Timeout for the HTTP request.
207+
timeout: Timeout for the API HTTP request.
208208
209209
Returns:
210210
The list of available Actors matching the specified filters.
@@ -271,7 +271,7 @@ async def create(
271271
it will be shut down.
272272
actor_standby_build: The build tag or number to run when the Actor is in Standby mode.
273273
actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.
274-
timeout: Timeout for the HTTP request.
274+
timeout: Timeout for the API HTTP request.
275275
276276
Returns:
277277
The created Actor.

‎src/apify_client/_resource_clients/actor_env_var.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def get(self, *, timeout: timedelta | None = None) -> EnvVar | None:
3737
https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable
3838
3939
Args:
40-
timeout: Timeout for the HTTP request.
40+
timeout: Timeout for the API HTTP request.
4141
4242
Returns:
4343
The retrieved Actor environment variable data.
@@ -63,7 +63,7 @@ def update(
6363
is_secret: Whether the environment variable is secret or not.
6464
name: The name of the environment variable.
6565
value: The value of the environment variable.
66-
timeout: Timeout for the HTTP request.
66+
timeout: Timeout for the API HTTP request.
6767
6868
Returns:
6969
The updated Actor environment variable.
@@ -80,7 +80,7 @@ def delete(self, *, timeout: timedelta | None = None) -> None:
8080
https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable
8181
8282
Args:
83-
timeout: Timeout for the HTTP request.
83+
timeout: Timeout for the API HTTP request.
8484
"""
8585
self._delete(timeout=timeout)
8686

@@ -112,7 +112,7 @@ async def get(self, *, timeout: timedelta | None = None) -> EnvVar | None:
112112
https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable
113113
114114
Args:
115-
timeout: Timeout for the HTTP request.
115+
timeout: Timeout for the API HTTP request.
116116
117117
Returns:
118118
The retrieved Actor environment variable data.
@@ -138,7 +138,7 @@ async def update(
138138
is_secret: Whether the environment variable is secret or not.
139139
name: The name of the environment variable.
140140
value: The value of the environment variable.
141-
timeout: Timeout for the HTTP request.
141+
timeout: Timeout for the API HTTP request.
142142
143143
Returns:
144144
The updated Actor environment variable.
@@ -155,6 +155,6 @@ async def delete(self, *, timeout: timedelta | None = None) -> None:
155155
https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable
156156
157157
Args:
158-
timeout: Timeout for the HTTP request.
158+
timeout: Timeout for the API HTTP request.
159159
"""
160160
await self._delete(timeout=timeout)

‎src/apify_client/_resource_clients/actor_env_var_collection.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def list(self, *, timeout: timedelta | None = None) -> ListOfEnvVars:
3535
https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables
3636
3737
Args:
38-
timeout: Timeout for the HTTP request.
38+
timeout: Timeout for the API HTTP request.
3939
4040
Returns:
4141
The list of available Actor environment variables.
@@ -59,7 +59,7 @@ def create(
5959
is_secret: Whether the environment variable is secret or not.
6060
name: The name of the environment variable.
6161
value: The value of the environment variable.
62-
timeout: Timeout for the HTTP request.
62+
timeout: Timeout for the API HTTP request.
6363
6464
Returns:
6565
The created Actor environment variable.
@@ -96,7 +96,7 @@ async def list(self, *, timeout: timedelta | None = None) -> ListOfEnvVars:
9696
https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables
9797
9898
Args:
99-
timeout: Timeout for the HTTP request.
99+
timeout: Timeout for the API HTTP request.
100100
101101
Returns:
102102
The list of available Actor environment variables.
@@ -120,7 +120,7 @@ async def create(
120120
is_secret: Whether the environment variable is secret or not.
121121
name: The name of the environment variable.
122122
value: The value of the environment variable.
123-
timeout: Timeout for the HTTP request.
123+
timeout: Timeout for the API HTTP request.
124124
125125
Returns:
126126
The created Actor environment variable.

‎src/apify_client/_resource_clients/actor_version.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def get(self, *, timeout: timedelta | None = None) -> Version | None:
5656
https://docs.apify.com/api/v2#/reference/actors/version-object/get-version
5757
5858
Args:
59-
timeout: Timeout for the HTTP request.
59+
timeout: Timeout for the API HTTP request.
6060
6161
Returns:
6262
The retrieved Actor version data.
@@ -98,7 +98,7 @@ def update(
9898
Required when `source_type` is `VersionSourceType.TARBALL`.
9999
github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.
100100
Required when `source_type` is `VersionSourceType.GITHUB_GIST`.
101-
timeout: Timeout for the HTTP request.
101+
timeout: Timeout for the API HTTP request.
102102
103103
Returns:
104104
The updated Actor version.
@@ -122,7 +122,7 @@ def delete(self, *, timeout: timedelta | None = None) -> None:
122122
https://docs.apify.com/api/v2#/reference/actors/version-object/delete-version
123123
124124
Args:
125-
timeout: Timeout for the HTTP request.
125+
timeout: Timeout for the API HTTP request.
126126
"""
127127
self._delete(timeout=timeout)
128128

@@ -172,7 +172,7 @@ async def get(self, *, timeout: timedelta | None = None) -> Version | None:
172172
https://docs.apify.com/api/v2#/reference/actors/version-object/get-version
173173
174174
Args:
175-
timeout: Timeout for the HTTP request.
175+
timeout: Timeout for the API HTTP request.
176176
177177
Returns:
178178
The retrieved Actor version data.
@@ -214,7 +214,7 @@ async def update(
214214
Required when `source_type` is `VersionSourceType.TARBALL`.
215215
github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.
216216
Required when `source_type` is `VersionSourceType.GITHUB_GIST`.
217-
timeout: Timeout for the HTTP request.
217+
timeout: Timeout for the API HTTP request.
218218
219219
Returns:
220220
The updated Actor version.
@@ -238,7 +238,7 @@ async def delete(self, *, timeout: timedelta | None = None) -> None:
238238
https://docs.apify.com/api/v2#/reference/actors/version-object/delete-version
239239
240240
Args:
241-
timeout: Timeout for the HTTP request.
241+
timeout: Timeout for the API HTTP request.
242242
"""
243243
await self._delete(timeout=timeout)
244244

‎src/apify_client/_resource_clients/actor_version_collection.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def list(self, *, timeout: timedelta | None = None) -> ListOfVersions:
4949
https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions
5050
5151
Args:
52-
timeout: Timeout for the HTTP request.
52+
timeout: Timeout for the API HTTP request.
5353
5454
Returns:
5555
The list of available Actor versions.
@@ -91,7 +91,7 @@ def create(
9191
Required when `source_type` is `VersionSourceType.TARBALL`.
9292
github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.
9393
Required when `source_type` is `VersionSourceType.GITHUB_GIST`.
94-
timeout: Timeout for the HTTP request.
94+
timeout: Timeout for the API HTTP request.
9595
9696
Returns:
9797
The created Actor version.
@@ -136,7 +136,7 @@ async def list(self, *, timeout: timedelta | None = None) -> ListOfVersions:
136136
https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions
137137
138138
Args:
139-
timeout: Timeout for the HTTP request.
139+
timeout: Timeout for the API HTTP request.
140140
141141
Returns:
142142
The list of available Actor versions.
@@ -178,7 +178,7 @@ async def create(
178178
Required when `source_type` is `VersionSourceType.TARBALL`.
179179
github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.
180180
Required when `source_type` is `VersionSourceType.GITHUB_GIST`.
181-
timeout: Timeout for the HTTP request.
181+
timeout: Timeout for the API HTTP request.
182182
183183
Returns:
184184
The created Actor version.

0 commit comments

Comments
 (0)