Slash notation should be defined in a notation key at the beginning of the Built-In Functions section
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 36k
- 平均合并
- 1 天 9 小时
- 30 天内合并 PR
- 558
描述
Documentation
The Standard Library defines a number of built-in functions, and a shorthand notation is used when a function is defined, such as the definition of repr:
repr(object, /)
But there is no information about what that "/' means in the function signature. It is not standard computer science notation, so I started looking for its meaning. Normally, a notation key should be at the beginning of the document or section, but I do not find a notation key either at the beginning of the section or at the beginning of the documentation.
Could a notation key be added please, to define the meaning of this and any other non-standard notation that is used in the Python documentation?
Linked PRs
- gh-142641
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 Python Standard Library documentation 的“Built-in Functions”部分开始,检查 repr(object, /) 周围的函数签名表示法。添加一个表示法说明,解释斜杠以及在那里识别出的任何其他非标准表示法;当读者无需查找其他资料就能理解这些签名时,文档就完成了。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100