The explanation of "Annotating callable objects" section should be made better
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- 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