`socket.AddressFamily` and `socket.SocketKind` are undocumented

Đang mở
#151,396 14 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
30/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

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.

Mô tả

docs
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
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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của python/cpython

Tất cả issue của python/cpython

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.