Improve documentation of SSL module
未關閉
還沒有人認領這個 Issue。
docs
topic-SSL
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 35.9k
- PR 合併指標
- PR 指標待擷取
描述
This is an umbrella issue for the points raised in https://github.com/python/cpython/pull/138269#discussion_r2328597995 that I will restate below:
- Indicate positional-only parameters in SSL docs.
- Indicate which OpenSSL version is required for a given functionality.
- Reword some English if needed (I don't know if it's needed but maybe).
- Fix Sphinx references warnings.
cc @ronf
Linked PRs
- gh-138639
- gh-138646 (held for now, can wait)
- gh-138647 (held for now, can wait)
- gh-138648
- gh-138656
貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
研究方向
從 SSL 文件中的相關要點和 PR 138269 中的討論開始，然後檢視相關的 PR 138639、138646、138647、138648 和 138656。完成的標準是解決剩餘的英文措辭問題，並完成文件檢查清單，同時不留下 Sphinx 參照警告。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 需要釐清
- 新手友好度
- 20/100