Docstring of array.array misses 'w' type info and mentions wide/narrow builds
未關閉
還沒有人認領這個 Issue。
docs
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- PR 合併指標
- PR 指標待擷取
描述
Documentation
The docstring of array.array at https://github.com/python/cpython/blob/cfcd52490d6531f3b0e8ddd4bb2b40fb6baee854/Modules/arraymodule.c#L2912 has a few mistakes:
- in description of 'u' type it mentions the narrow/wide build split that is not a thing since 3.3 - https://docs.python.org/3/whatsnew/3.3.html#functionality
- it doesn't mention that since 3.3 the 'u' type is deprecated and 'w' should be used.
- it doesn't mention that 'u' type since 3.9 corresponds to
wchar_tof C compiler used (so usually 2 byte UTF-16 on Windows, 4 byte UTF-32 elsewhere), instead of to narrow/wide Python build. - it doesn't mention the newer 'w' type that is Python's own
Py_UCS44 byte UTF-32.
The documentation at https://docs.python.org/3/library/array.html doesn't have these issues, only the docstring (that is shown in help(array.array) in the REPL) does. This is a mismatch between documentation and docstring.
Linked PRs
- gh-142323
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
先從 Modules/arraymodule.c 中 issue 所參照的 array.array docstring 附近開始,然後將其與 docs.python.org/3/library/array.html 中的 array 文件進行比較。完成的標準是:docstring 涵蓋目前的 'u' 和 'w' 型別資訊,且不再使用關於 narrow/wide build 的過時措辭;開始前檢查已連結的 PR gh-142323。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- c, python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 1/5
- 預估耗時
- 1 小時以內
- 活躍度
- 停滯
- 描述清晰度
- 描述清楚
- 新手友好度
- 30/100