diff --git a/geti_sdk/geti.py b/geti_sdk/geti.py index 002e48b9..0715c373 100644 --- a/geti_sdk/geti.py +++ b/geti_sdk/geti.py @@ -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 diff --git a/geti_sdk/rest_clients/project_client/project_client.py b/geti_sdk/rest_clients/project_client/project_client.py index f00e930a..308c40ab 100644 --- a/geti_sdk/rest_clients/project_client/project_client.py +++ b/geti_sdk/rest_clients/project_client/project_client.py @@ -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