Argument Clinic: add reference for all directives
未關閉
還沒有人認領這個 Issue。
type-feature
- 主要語言
- Python
- 星號
- 2.1k
- 分支
- 1k
- 平均合併
- 2 天 12 小時
- 30 天內合併 PR
- 12
描述
We need a good reference for all Argument Clinic directives (@getter, output, etc.). Some of the directives accept one or more parameters; perhaps we can use typical CLI documentation for inspiration (@critical_section [arg1] [arg2]).
貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
研究方向
首先找出現有的 Argument Clinic 文件和目前的指令定義。盤點所有指令，包括帶有參數的指令，並將其語法與 issue 中 CLI 風格的範例進行比較。當 devguide 提供一份涵蓋每個指令及其可接受參數的清楚參考文件時，工作就完成了。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100