Skip to content

Commit 84b3e8a

Browse files
committed
Added missing argument types to some method docstrings
1 parent e385c18 commit 84b3e8a

File tree

3 files changed

+20
-22
lines changed

3 files changed

+20
-22
lines changed

docs/docs.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -4776,15 +4776,14 @@ Create a new schedule.
47764776

47774777
* **is_exclusive** (`bool`) – When set to true, don’t start actor or actor task if it’s still running from the previous schedule.
47784778

4779-
* **name** (`Optional[str]`) – The name of the schedule to create.
4780-
4781-
* **actions** (`Optional`[`List[Dict]`]) – Actors or tasks that should be run on this schedule. See the API documentation for exact structure.
4779+
* **name** (`str`, *optional*) – The name of the schedule to create.
47824780

4783-
* **description** (`Optional[str]`) – Description of this schedule
4781+
* **actions** (`list of dict`, *optional*) – Actors or tasks that should be run on this schedule. See the API documentation for exact structure.
47844782

4785-
* **timezone** (`Optional[str]`) – Timezone in which your cron expression runs (TZ database name from [https://en.wikipedia.org/wiki/List_of_tz_database_time_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones))
4783+
* **description** (`str`, *optional*) – Description of this schedule
47864784

4787-
* **title** (`Optional[str]`) – A human-friendly equivalent of the name
4785+
* **timezone** (`str`, *optional*) – Timezone in which your cron expression runs
4786+
(TZ database name from [https://en.wikipedia.org/wiki/List_of_tz_database_time_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones))
47884787

47894788
* **Returns**
47904789

@@ -5791,15 +5790,14 @@ Create a new schedule.
57915790

57925791
* **is_exclusive** (`bool`) – When set to true, don’t start actor or actor task if it’s still running from the previous schedule.
57935792

5794-
* **name** (`Optional[str]`) – The name of the schedule to create.
5795-
5796-
* **actions** (`Optional`[`List[Dict]`]) – Actors or tasks that should be run on this schedule. See the API documentation for exact structure.
5793+
* **name** (`str`, *optional*) – The name of the schedule to create.
57975794

5798-
* **description** (`Optional[str]`) – Description of this schedule
5795+
* **actions** (`list of dict`, *optional*) – Actors or tasks that should be run on this schedule. See the API documentation for exact structure.
57995796

5800-
* **timezone** (`Optional[str]`) – Timezone in which your cron expression runs (TZ database name from [https://en.wikipedia.org/wiki/List_of_tz_database_time_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones))
5797+
* **description** (`str`, *optional*) – Description of this schedule
58015798

5802-
* **title** (`Optional[str]`) – A human-friendly equivalent of the name
5799+
* **timezone** (`str`, *optional*) – Timezone in which your cron expression runs
5800+
(TZ database name from [https://en.wikipedia.org/wiki/List_of_tz_database_time_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones))
58035801

58045802
* **Returns**
58055803

src/apify_client/_errors.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ def __init__(self, response: httpx.Response, attempt: int) -> None:
2222
"""Create the ApifyApiError instance.
2323
2424
Args:
25-
response: The response to the failed API call
26-
attempt: Which attempt was the request that failed
25+
response (httpx.Response): The response to the failed API call
26+
attempt (int): Which attempt was the request that failed
2727
"""
2828
self.message: Optional[str] = None
2929
self.type: Optional[str] = None

src/apify_client/clients/resource_clients/schedule_collection.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@ def create(
5151
https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule
5252
5353
Args:
54-
cron_expression: The cron expression used by this schedule
55-
is_enabled: True if the schedule should be enabled
56-
is_exclusive: When set to true, don't start actor or actor task if it's still running from the previous schedule.
57-
name: The name of the schedule to create.
58-
actions: Actors or tasks that should be run on this schedule. See the API documentation for exact structure.
59-
description: Description of this schedule
60-
timezone: Timezone in which your cron expression runs (TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
61-
title: A human-friendly equivalent of the name
54+
cron_expression (str): The cron expression used by this schedule
55+
is_enabled (bool): True if the schedule should be enabled
56+
is_exclusive (bool): When set to true, don't start actor or actor task if it's still running from the previous schedule.
57+
name (str, optional): The name of the schedule to create.
58+
actions (list of dict, optional): Actors or tasks that should be run on this schedule. See the API documentation for exact structure.
59+
description (str, optional): Description of this schedule
60+
timezone (str, optional): Timezone in which your cron expression runs
61+
(TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
6262
6363
Returns:
6464
dict: The created schedule.

0 commit comments

Comments
 (0)