Misplaced or duplicated function descriptions in the multiprocessing documentation
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 36k
- Merge trung bình
- 1 ngày 9 giờ
- Pull request đã merge (30 ngày)
- 558
Mô tả
Documentation
In the documentation of the multiprocessing module, some public functions of the root module are undocumented but their submodule counterparts are (misplaced information):
multiprocessing.RawValueis undocumented butmultiprocessing.sharedctypes.RawValueis documented;multiprocessing.RawArrayis undocumented butmultiprocessing.sharedctypes.RawArrayis documented;multiprocessing.Poolis undocumented butmultiprocessing.pool.Poolis documented.
And some public functions of the root module are documented but also their submodule counterparts (duplicated information):
multiprocessing.Valueis documented andmultiprocessing.sharedctypes.Valueis documented;multiprocessing.Arrayis documented andmultiprocessing.sharedctypes.Arrayis documented.
Linked PRs
- gh-31482
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 trang tài liệu về multiprocessing và so sánh các mục của mô-đun gốc với các phần sharedctypes và pool. Kiểm tra các export tương ứng trong Lib/multiprocessing/context.py, sau đó cập nhật tài liệu để RawValue, RawArray và Pool được bao quát, còn Value và Array không bị trùng lặp; gh-31482 được liệt kê là một 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
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 30/100