`socket.AddressFamily` and `socket.SocketKind` are undocumented
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 35.9k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
Documentation
The socket.AddressFamily and socket.SocketKind values are not documented. As a result, (inter)Sphinx can generate mappings to it. This is visible in the official documentation at socket constants and in my project at wakeonlan.send_magic_packet.
It looks like this was previously reported in #64888, and some fixes are linked in https://github.com/python/cpython/issues/64888#issuecomment-1093646909. However, the documentation is still absent.
Linked PRs
- gh-151495
- gh-153286
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 phần các hằng số socket trong tài liệu chính thức và xem lại cuộc thảo luận trước đó trong issue #64888, bao gồm cả các bản sửa lỗi được liên kết. Kiểm tra cách socket.AddressFamily và socket.SocketKind được cung cấp tại đó, cũng như những gì các PR được liên kết đã bao quát. Công việc được xem là hoàn tất khi cả hai giá trị đều được lập tài liệu và các ánh xạ Sphinx được phân giải chính xác.
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
- 30/100