`get_project_roots_by_site_id` return value
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 16
- Forks
- 15
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 10
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:
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100