Some server class attributes are missing in socketserver docs
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 36k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
Documentation
While working with socketserver recently I noticed that the allow_reuse_port class attribute is not documented but the allow_reuse_address attribute is.
In addition there's a couple of places we could clean up right now, for instance address_family is still grouped with the per-instance attributes rather than the class attributes, request_queue_size is only applicable to TCP, and there's another missing undocumented class attribute for specifying max packet size that is only applicable to UDP.
Linked PRs
- gh-128320
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 socketserver và so sánh phần mô tả các thuộc tính lớp của tài liệu này với Lib/socketserver.py quanh các dòng 185-198. Hoàn tất nghĩa là đã lập tài liệu cho allow_reuse_port, nhóm address_family đúng cách, làm rõ rằng request_queue_size áp dụng cho TCP và lập tài liệu cho thuộc tính kích thước gói tối đa chỉ dành cho UDP; gh-128320 được liên kết trong issue.
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
- 35/100