`get_project_roots_by_site_id` return value

Open

#181 opened on Sep 17, 2024 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 1/5
Estimated time: Under an hour
Newbie friendliness: 55/100

Issue type: Bug
Clarity: Clearly specified
Activity status: Stale
Tech stack: python
Domain: api

Research direction

Search for the get_project_roots_by_site_id definition and read its implementation alongside the docstring. Align the documented return type with the observed dict[str, str] value, then check the surrounding API documentation or type hints for consistency.

Written by the indexing model from the issue text.

Description

Is there an existing issue for this?

I have searched the existing issues

Current Behavior:

Calling:

ayon_api.get_project_roots_by_site_id(get_current_project_name())

will return just dict[str, str] like:

{'work': 'C:/projects'}

but the docstring states that the return value is dict[str, dict[str ,str]]

Expected Behavior:

Docstring should reflect real state otherwise IDEs will show wrong type hints.

Version

1.0.0

What platform you are running on?

Windows

Steps To Reproduce:

Look at the function docstring

Are there any labels you wish to add?

I have added the relevant labels to the bug report.

Relevant log output:

No response

Additional context: