subprocess module docs contain an inconsistent mix of repeated versionchanged descriptions
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 38/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先查看 subprocess 模块文档和 issue 101283,然后比较 Popen、run()、call()、check_call() 和 check_output() 的 versionchanged 与 versionadded 注释。检查这些 API 中对 cwd、input、text、encoding 和 errors 的文档说明方式。完成的标准是这些注释遵循一致的策略,且没有重复或相互冲突的描述。
由索引模型根据 Issue 内容生成。
描述
Documentation
The subprocess module documentation has an explosion of repeated text in versionchanged or versionadded markers splattered over multiple APIs within the docs.
The reality is that many of these are technically all directly Popen API changes, that the other higher level preferred more user friendly APIs like run() and call() and check_call() and check_output() all make use of internally and forward a majority of their arguments to.
Examples to look for: where are cwd, input, text, encoding, errors argument behavior changes/additions mentioned vs which APIs accept these.
I noticed this when looking over the changes made in https://github.com/python/cpython/issues/101283 where it became apparent to me that we're not internally consistent in how we do this within the doc today. The doc needs some cleanup and a strategy for this.
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 36k
- 平均合并
- 1 天 9 小时
- 30 天内合并 PR
- 558
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
python/cpython 的其他 Issue
-
docs pending
难度 2/5 1-3 小时 新手友好度 78/100
-
stdlib type-feature
难度 2/5 1-3 小时 新手友好度 78/100
-
stdlib type-feature
难度 2/5 1-3 小时 新手友好度 72/100
-
build type-bug
难度 2/5 1-3 小时 新手友好度 76/100
-
stdlib topic-email type-feature
难度 2/5 1-3 小时 新手友好度 70/100