python / python/docs-community
ABC documentation needs more details on usage
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Makefile
- Star
- 55
- Fork
- 26
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
I am trying to use Abstract Base Classes. But I find the documentation lacking on several points that makes the matter too 'abstract'.
For example. There is no explanation on making abstract objects mandatory by using exceptions
Or how to implement Iterable abstract bsse class that can be inherited from and still be usable.
Can someone shed more light onto this so that the documentation is more accessible?
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
- Đọ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 bằng cách xác định tài liệu về Abstract Base Classes và xem xét mức độ bao quát hiện tại của tài liệu đối với các đối tượng trừu tượng, ngoại lệ và tính kế thừa của Iterable. Công việc được xem là hoàn thành khi tài liệu giải thích rõ ràng các mẫu sử dụng được yêu cầu và giúp người đọc dễ tiếp cận các ví dụ; issue không nêu tên tệp hoặc bài kiểm thử cụ thể nào.
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ó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100