Misplaced or duplicated function descriptions in the multiprocessing documentation
未关闭
还没有人认领这个 Issue。
docs
topic-multiprocessing
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 36k
- PR 合并指标
- PR 指标待抓取
描述
Documentation
In the documentation of the multiprocessing module, some public functions of the root module are undocumented but their submodule counterparts are (misplaced information):
multiprocessing.RawValueis undocumented butmultiprocessing.sharedctypes.RawValueis documented;multiprocessing.RawArrayis undocumented butmultiprocessing.sharedctypes.RawArrayis documented;multiprocessing.Poolis undocumented butmultiprocessing.pool.Poolis documented.
And some public functions of the root module are documented but also their submodule counterparts (duplicated information):
multiprocessing.Valueis documented andmultiprocessing.sharedctypes.Valueis documented;multiprocessing.Arrayis documented andmultiprocessing.sharedctypes.Arrayis documented.
Linked PRs
- gh-31482
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 multiprocessing 文档页面开始,将根模块条目与 sharedctypes 和 pool 部分进行比较。检查 Lib/multiprocessing/context.py 中对应的导出,然后更新文档,使其涵盖 RawValue、RawArray 和 Pool,同时不重复列出 Value 和 Array;gh-31482 已列为关联的 PR。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 描述清楚
- 新手友好度
- 30/100