docs: submodule documentation doesn't mention that SubmoduleCollection is a sequence of Submodule instances
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 1.7k
- Fork
- 408
- Merge trung bình
- 2 ngày 57 phút
- Pull request đã merge (30 ngày)
- 7
Mô tả
I spent a few minutes going over https://www.pygit2.org/submodule.html trying to understand how to get all the submodules from a SubmoduleCollection. It turns out that you can just iterate over it. I think it would be good if the documentation mentioned it (perhaps listing __getitem__ and __iter__ in the list of methods, as is the case in https://www.pygit2.org/objects.html#trees).
Thanks!
Noam
Hướng dẫn đóng góp
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.
Hướng nghiên cứu
Bắt đầu với tài liệu về Submodule tại pygit2.org/submodule.html và so sánh danh sách phương thức của tài liệu này với tài liệu về Trees tại pygit2.org/objects.html#trees. Ghi lại rằng SubmoduleCollection là một sequence gồm các thực thể Submodule, bao gồm hành vi của getitem và iter; hoàn thành khi người dùng có thể thấy cách lặp qua tất cả các submodule.
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
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 1/5
- Thời gian dự kiến
- Dưới một giờ
- Mức độ hoạt động
- Sôi nổi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 88/100