ynput / ynput/ayon-python-api

`get_project_roots_by_site_id` return value

Đang mở
#181 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Python
Star
16
Fork
15
Merge trung bình
1 ngày 9 giờ
Pull request đã merge (30 ngày)
10

Mô tả

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

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Tìm định nghĩa của get_project_roots_by_site_id và đọc phần triển khai của nó cùng với docstring. Điều chỉnh kiểu trả về được ghi trong tài liệu cho khớp với giá trị quan sát được dict[str, str], sau đó kiểm tra tính nhất quán của tài liệu API xung quanh hoặc các type hint.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
api
Loại issue
Lỗi
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
55/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.