Skip to content

Commit bf7e3c6

Browse files
authored
chore(jobs): update docs (#1510)
1 parent ad1e773 commit bf7e3c6

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

scaleway-async/scaleway_async/jobs/v1alpha2/api.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ async def create_job_definition(
8787
:param image_uri: Image to use for the job.
8888
:param name: Name of the job definition.
8989
:param description: Description of the job.
90-
:param command: Deprecated in favor of startup_command.
90+
:param command: Deprecated: please use startup_command instead.
9191
:param startup_command: The main executable or entrypoint script to run.
9292
If both command and startup_command are provided, only startup_command will be used.
9393
:param args: Passed to the startup command at runtime.
@@ -289,7 +289,7 @@ async def update_job_definition(
289289
:param memory_limit: Memory limit of the job (in MiB).
290290
:param local_storage_capacity: Local storage capacity of the job (in MiB).
291291
:param image_uri: Image to use for the job.
292-
:param command: Deprecated in favor of startup_command.
292+
:param command: Deprecated: please use startup_command instead.
293293
:param startup_command: The main executable or entrypoint script to run.
294294
If both command and startup_command are provided, only startup_command will be used.
295295
:param args: Passed to the startup command at runtime.
@@ -391,7 +391,7 @@ async def start_job_definition(
391391
:param job_definition_id: UUID of the job definition to start.
392392
:param region: Region to target. If none is passed will use default region from the config.
393393
:param command: If empty or not defined, the image's default command is used.
394-
Deprecated in favor of startup_command.
394+
Deprecated: please use startup_command instead.
395395
:param startup_command: Overrides the default defined in the job image.
396396
The main executable or entrypoint script to run.
397397
If both command and startup_command are provided, only startup_command will be used.

scaleway-async/scaleway_async/jobs/v1alpha2/types.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ class CreateJobDefinitionRequest:
232232

233233
command: Optional[str] = None
234234
"""
235-
Deprecated in favor of startup_command.
235+
Deprecated: please use startup_command instead.
236236
"""
237237

238238
startup_command: Optional[list[str]] = field(default_factory=list)
@@ -470,7 +470,7 @@ class StartJobDefinitionRequest:
470470
command: Optional[str] = None
471471
"""
472472
If empty or not defined, the image's default command is used.
473-
Deprecated in favor of startup_command.
473+
Deprecated: please use startup_command instead.
474474
"""
475475

476476
startup_command: Optional[list[str]] = field(default_factory=list)
@@ -558,7 +558,7 @@ class UpdateJobDefinitionRequest:
558558

559559
command: Optional[str] = None
560560
"""
561-
Deprecated in favor of startup_command.
561+
Deprecated: please use startup_command instead.
562562
"""
563563

564564
startup_command: Optional[list[str]] = field(default_factory=list)

scaleway/scaleway/jobs/v1alpha2/api.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ def create_job_definition(
8787
:param image_uri: Image to use for the job.
8888
:param name: Name of the job definition.
8989
:param description: Description of the job.
90-
:param command: Deprecated in favor of startup_command.
90+
:param command: Deprecated: please use startup_command instead.
9191
:param startup_command: The main executable or entrypoint script to run.
9292
If both command and startup_command are provided, only startup_command will be used.
9393
:param args: Passed to the startup command at runtime.
@@ -289,7 +289,7 @@ def update_job_definition(
289289
:param memory_limit: Memory limit of the job (in MiB).
290290
:param local_storage_capacity: Local storage capacity of the job (in MiB).
291291
:param image_uri: Image to use for the job.
292-
:param command: Deprecated in favor of startup_command.
292+
:param command: Deprecated: please use startup_command instead.
293293
:param startup_command: The main executable or entrypoint script to run.
294294
If both command and startup_command are provided, only startup_command will be used.
295295
:param args: Passed to the startup command at runtime.
@@ -391,7 +391,7 @@ def start_job_definition(
391391
:param job_definition_id: UUID of the job definition to start.
392392
:param region: Region to target. If none is passed will use default region from the config.
393393
:param command: If empty or not defined, the image's default command is used.
394-
Deprecated in favor of startup_command.
394+
Deprecated: please use startup_command instead.
395395
:param startup_command: Overrides the default defined in the job image.
396396
The main executable or entrypoint script to run.
397397
If both command and startup_command are provided, only startup_command will be used.

scaleway/scaleway/jobs/v1alpha2/types.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ class CreateJobDefinitionRequest:
232232

233233
command: Optional[str] = None
234234
"""
235-
Deprecated in favor of startup_command.
235+
Deprecated: please use startup_command instead.
236236
"""
237237

238238
startup_command: Optional[list[str]] = field(default_factory=list)
@@ -470,7 +470,7 @@ class StartJobDefinitionRequest:
470470
command: Optional[str] = None
471471
"""
472472
If empty or not defined, the image's default command is used.
473-
Deprecated in favor of startup_command.
473+
Deprecated: please use startup_command instead.
474474
"""
475475

476476
startup_command: Optional[list[str]] = field(default_factory=list)
@@ -558,7 +558,7 @@ class UpdateJobDefinitionRequest:
558558

559559
command: Optional[str] = None
560560
"""
561-
Deprecated in favor of startup_command.
561+
Deprecated: please use startup_command instead.
562562
"""
563563

564564
startup_command: Optional[list[str]] = field(default_factory=list)

0 commit comments

Comments
 (0)