Argument Clinic: add reference for the DSL
未关闭
还没有人认领这个 Issue。
type-feature
- 主要语言
- Python
- 星标
- 2.1k
- 派生
- 1k
- 平均合并
- 2 天 12 小时
- 30 天内合并 PR
- 12
描述
We need a better reference for the Argument Clinic DSL:
- legal syntax for the "function name" line
- legal syntax for parameter lines
- legal syntax for docstrings
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先定位现有的 Argument Clinic 文档,以及 devguide 中当前的所有 DSL 引用。将文档所涵盖的内容与所要求的函数名语法、参数行语法和 docstring 语法进行比较;当有一份参考文档解释这三个方面的合法语法时,工作就完成了。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100