Skip to content

Tidy docstring typing #361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2024
Merged

Tidy docstring typing #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions simvue/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,11 +721,11 @@ def get_artifacts_as_files(
path : str | None, optional
location to download files to, the default of None will download
them to the current working directory
startswith : typing.Optional[str], optional
startswith : str, optional
only download artifacts with this prefix in their name, by default None
contains : typing.Optional[str], optional
contains : str, optional
only download artifacts containing this term in their name, by default None
endswith : typing.Optional[str], optional
endswith : str, optional
only download artifacts ending in this term in their name, by default None

Raises
Expand Down Expand Up @@ -1104,11 +1104,11 @@ def get_events(
----------
run_id : str
the unique identifier of the run to query
message_contains : typing.Optional[str], optional
message_contains : str, optional
filter to events with message containing this expression, by default None
start_index : typing.Optional[int], optional
start_index : typing.int, optional
slice results returning only those above this index, by default None
count_limit : typing.Optional[int], optional
count_limit : typing.int, optional
limit number of returned results, by default None

Returns
Expand Down
16 changes: 8 additions & 8 deletions simvue/run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,21 +465,21 @@ def init(

Parameters
----------
name : typing.Optional[str], optional
name : str, optional
the name to allocate this run, if not specified a name will be
selected at random, by default None
metadata : typing.Optional[dict[str, typing.Any]], optional
metadata : typing.dict[str, typing.Any], optional
any metadata relating to the run as key-value pairs, by default None
tags : typing.Optional[list[str]], optional
tags : typing.list[str], optional
a list of tags for this run, by default None
description : typing.Optional[str], optional
description : str, optional
description of the run, by default None
folder : str, optional
folder within which to store the run, by default "/"
running : bool, optional
whether to set the status as running or created, the latter implying
the run will be commenced at a later time. Default is True.
retention_period : typing.Optional[str], optional
retention_period : str, optional
describer for time period to retain run, the default of None
removes this constraint.
resources_metrics_interval : int, optional
Expand Down Expand Up @@ -749,7 +749,7 @@ def reconnect(self, run_id: str) -> bool:
----------
run_id : str
identifier of run to connect to
uid : typing.Optional[str], optional
uid : str, optional
unique identifier for this run, by default None

Returns
Expand Down Expand Up @@ -1324,9 +1324,9 @@ def add_alerts(

Parameters
----------
ids : typing.Optional[list[str]], optional
ids : typing.list[str], optional
unique identifiers of the alerts to attach, by default None
names : typing.Optional[list[str]], optional
names : typing.list[str], optional
names of alerts to attach, by default None

Returns
Expand Down
Loading