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

未關閉
#151,396 14 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
30/100
Issue 類型
文件
描述清晰度
基本清楚
活躍度
停滯
技術堆疊
python
領域
documentation

研究方向

從官方文件中的 socket 常數部分開始,並檢視 issue #64888 中先前的討論,包括其中連結的修正。確認其中如何公開 socket.AddressFamily 和 socket.SocketKind,以及連結的 PR 已經涵蓋哪些內容。當兩個值都已完成文件化,且 Sphinx 對映能正確解析時,即表示完成。

由索引模型根據 Issue 內容生成。

描述

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
主要語言
Python
星號
77.2k
分支
36k
平均合併
1 天 9 小時
30 天內合併 PR
558

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

python/cpython 的其他 Issue

查看 python/cpython 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。