Improve usage info in docstrings
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 45/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- python
- Lĩnh vực
- documentation, tooling
Hướng nghiên cứu
Bắt đầu từ điểm vào của quá trình tạo docstring và tái hiện định dạng được thể hiện trong issue. Theo dõi cách phần mô tả và dòng Usage được ghép lại, sau đó xác minh rằng đầu ra được tạo tách Usage rõ ràng khỏi dòng mô tả cuối cùng và vẫn dễ đọc.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
What
Improve the docstring generation so that it'd doesn't butt usage up below the last line of the description.
Why
still be presented with standard Host UI for the type as an
option.
* If the "exclusive" property is set to true, then the Manager
takes exclusive control over data with the queried trait set,
and any standard host interfaces etc should be suppressed.
Usage: managementPolicy
Its a bit hard to grok, some whitespace, or moving before the body text might help?
- Ngôn ngữ chính
- Python
- Star
- 7
- Fork
- 7
- Merge trung bình
- 1 giờ 7 phút
- Pull request đã merge (30 ngày)
- 1
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của OpenAssetIO/OpenAssetIO-TraitGen
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 38/100
OpenAssetIO/OpenAssetIO-TraitGen#123 · 2 bình luận ·
-
good first issue
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
OpenAssetIO/OpenAssetIO-TraitGen#93 · 1 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
OpenAssetIO/OpenAssetIO-TraitGen#84 · 2 bình luận ·
-
Trait mutual exclusivityĐang mởbreaking change risk
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Tất cả issue của OpenAssetIO/OpenAssetIO-TraitGen
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 1 ngày
-
With emit_ontology_keys, one ontology key change is reported as two errors (keys and keys_digest)Có thể đã có người làm @rvandewater đã nhận hôm nay. Đang mởbug priority:low
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 84/100
iausathub/satchecker#286 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug test
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
OpenAssetIO/OpenAssetIO#1527 ·
-
automated endpoint-dead needs-curation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
almanac-data/climate-almanac#128 ·
Maintainer thường phản hồi trong vòng 1 ngày