Skip to content

Commit

Permalink
expand updated methods docstrings
Browse files Browse the repository at this point in the history
Signed-off-by: Igor-Davidyuk <[email protected]>
  • Loading branch information
igor-davidyuk committed Sep 12, 2024
1 parent 41ce4d5 commit 2faeac2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
10 changes: 6 additions & 4 deletions geti_sdk/geti.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,12 +263,14 @@ def get_project(
If no project by that name is found on the Intel® Geti™ server,
this method will raise a KeyError.
:param project_name: Name of the project to retrieve
:param project_name: Name of the project to retrieve.
:param project_id: ID of the project to retrieve. If not specified, the
project with name `project_name` will be retrieved.
:param project: Project object to update. If not specified, the project with
:raises: KeyError if project named `project_name` is not found on the server
:return: Project identified by `project_name`
:param project: Project object to update. If provided, the associated `project_id`
will be used to update the project object.
:raises: KeyError if the project identified by one of the arguments is not found on the server
:raises: ValueError if there are several projects on the server named `project_name`
:return: Project identified by one of the arguments.
"""
project = self.project_client.get_project(
project_name=project_name, project_id=project_id, project=project
Expand Down
4 changes: 2 additions & 2 deletions geti_sdk/rest_clients/project_client/project_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ def get_project_by_name(
Get a project from the Intel® Geti™ server by project_name.
If multiple projects with the same name exist on the server, this method will
raise a ValueError. In that case, please use the `ProjectClient.get_project()` method and provide a `project_id` to uniquely identify the project
project.
raise a ValueError. In that case, please use the `ProjectClient.get_project()`
method and provide a `project_id` to uniquely identify the project.
:param project_name: Name of the project to get
:raises: ValueError in case multiple projects with the specified name exist on
Expand Down

0 comments on commit 2faeac2

Please sign in to comment.