The explanation of "Annotating callable objects" section should be made better
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 35.9k
- PR 合并指标
- PR 指标待抓取
描述
Documentation
*Notes:
- Python 3.14.3
- Related: #145602
In the explanation of Annotating callable objects section, some words or sentence aren't clear, distinct, specific, concise and less common, and the word argument is misused, etc. So they should be corrected:
<Some examples>
The 1st one:
*Notes:
- "has" is better than "takes" because "takes" sounds taking an argument but not parameter:
... a function that takes a single parameter of type
intand returns astr.
... a function that has a single parameter of type
intand returns astr.
The 2nd one:
*Notes:
- Naming and calling
[]"type specification" is more understandable than "subscription syntax". - "must" is enough for emphasis so "always" and "exactly" aren't needed, emphasizing too much.
- "two objects" are better than "two values" because "two values" sounds actual values like
v = "Hello"'s"Hello"so it's confusing while talking about types. - "parameter type list" is better than "argument list" because "parameter" is correct and "type list" is more specific and understandable.
The subscription syntax must always be used with exactly two values: the
argument list and the return type.
The type specification
[]must have two objects, a parameter type list and return type.
etc.
Linked PRs
- gh-145576
- gh-145598
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 Python typing 文档中的 "Annotating callable objects" 部分开始,以措辞示例和相关 issue #145602、#145576 及 #145598 作为背景。审阅提议的术语和句子修改,然后确认该部分始终清楚地区分形参、实参、对象和类型。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100