Argument Clinic How-To needs more examples
Đang mở
Chưa có ai nhận issue này.
type-feature
- Ngôn ngữ chính
- Python
- Star
- 2.1k
- Fork
- 1k
- Merge trung bình
- 2 ngày 12 giờ
- Pull request đã merge (30 ngày)
- 12
Mô tả
Documentation
Currently, the example for AC How-To is the method _pickle.Pickler.dump. I think it is not proper since it cannot cover all cases and makes readers confused. A more intuitive example should be considered to replace the current one.
Linked PRs
- python/cpython#106800
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
Đọc Argument Clinic How-To và kiểm tra ví dụ hiện tại về _pickle.Pickler.dump. So sánh ví dụ đó với các trường hợp mà hướng dẫn cần bao quát, sau đó thay thế ví dụ bằng một ví dụ trực quan hơn hoặc thêm các ví dụ nếu phù hợp; tài liệu không nên tiếp tục khiến người đọc bối rối và nên phản ánh thay đổi đã được thống nhất trong PR được liên kết.
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ó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 25/100