Documentation for os.exec* functions omits information about required argument
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 35.9k
- PR 合并指标
- PR 指标待抓取
描述
Documentation
All of the os.exec* functions (there are 8) require the path to the executable to be the first argument given to the executable, as well as specified in the path or file parameter of the exec method. The documentation of the exec* functions doesn't include any information about this requirement, however it can be found at the start of the Process management section of the documentation. I think it should be moved to the exec* function documentation.
Additionally I personally think that the discussion of the different variants of the function is a bit confusing and would be easier to understand if it was structured differently and a few headings were added.
I have some ideas about how to do this and intend to put together a pull request addressing the issues.
Linked PRs
- gh-125565
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从链接的 library/os.html#os.execl 部分中的 os.exec* 文档开始,并将其与 Process management 部分进行比较。开始之前先查看链接的 PR gh-125565;当必需的可执行文件路径参数已随函数记录,并且对变体的讨论更加清晰时,这项工作就完成了。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100