ynput / ynput/ayon-python-api

`get_project_roots_by_site_id` return value

オープン
#181 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Python
スター
16
フォーク
15
平均マージ
1日 9時間
マージ済み PR(30日)
10

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

get_project_roots_by_site_id の定義を検索し、docstring と併せてその実装を確認します。ドキュメントに記載された戻り値の型を、実際に確認できる値 dict[str, str] に合わせ、その後、周辺の API ドキュメントまたは型ヒントに一貫性があるか確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api
issue の種類
バグ
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。