`socket.AddressFamily` and `socket.SocketKind` are undocumented
未关闭
还没有人认领这个 Issue。
docs
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 35.9k
- PR 合并指标
- PR 指标待抓取
描述
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
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从官方文档中的 socket 常量部分开始,并查看 issue #64888 中之前的讨论,包括其中链接的修复。检查其中如何公开 socket.AddressFamily 和 socket.SocketKind,以及链接的 PR 已经涵盖了哪些内容。当两个值都已记录,并且 Sphinx 映射能够正确解析时,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 30/100