|
@@ -246,7 +246,7 @@ def submit(
|
|
|
in asynchronous mode.
|
|
|
timeout (Union[float, int]): The optional maximum number of seconds to wait
|
|
|
for the jobs to be finished before returning.
|
|
|
- **properties (dict[str, any]): A keyworded variable length list of user additional arguments
|
|
|
+ **properties (dict[str, any]): A key-worded variable length list of user additional arguments
|
|
|
that will be stored within the `Submission^`. It can be accessed via `Submission.properties^`.
|
|
|
|
|
|
Returns:
|
|
@@ -530,7 +530,7 @@ def get_scenarios(
|
|
|
The default value is False.
|
|
|
descending (bool): If True, sort the output list of scenarios in descending order.
|
|
|
The default value is False.
|
|
|
- sort_key (Literal["name", "id", "creation_date", "tags"]): The optiononal sort_key to
|
|
|
+ sort_key (Literal["name", "id", "creation_date", "tags"]): The optional sort_key to
|
|
|
decide upon what key scenarios are sorted. The sorting is in increasing order for
|
|
|
dates, in alphabetical order for name and id, and in lexicographical order for tags.
|
|
|
The default value is "name".<br/>
|
|
@@ -582,7 +582,7 @@ def get_primary_scenarios(
|
|
|
The default value is False.
|
|
|
descending (bool): If True, sort the output list of scenarios in descending order.
|
|
|
The default value is False.
|
|
|
- sort_key (Literal["name", "id", "creation_date", "tags"]): The optiononal sort_key to
|
|
|
+ sort_key (Literal["name", "id", "creation_date", "tags"]): The optional sort_key to
|
|
|
decide upon what key scenarios are sorted. The sorting is in increasing order for
|
|
|
dates, in alphabetical order for name and id, and in lexicographical order for tags.
|
|
|
The default value is "name".<br/>
|
|
@@ -605,7 +605,7 @@ def is_promotable(scenario: Union[Scenario, ScenarioId]) -> bool:
|
|
|
as a primary scenario.
|
|
|
|
|
|
Parameters:
|
|
|
- scenario (Union[Scenario, ScenarioId]): The scenario to be evaluated for promotability.
|
|
|
+ scenario (Union[Scenario, ScenarioId]): The scenario to be evaluated for promotion.
|
|
|
|
|
|
Returns:
|
|
|
True if the given scenario can be promoted to be a primary scenario. False otherwise.
|
|
@@ -987,7 +987,7 @@ def export_scenario(
|
|
|
override: bool = False,
|
|
|
include_data: bool = False,
|
|
|
):
|
|
|
- """Export all related entities of a scenario to a archive zip file.
|
|
|
+ """Export all related entities of a scenario to an archive zip file.
|
|
|
|
|
|
This function exports all related entities of the specified scenario to the
|
|
|
specified archive zip file.
|