docstring - 按 PyTorch 规范编写 Docstring
按照 PyTorch 的 Sphinx/reStructuredText 规范为函数和方法编写 docstring。
标签
更新于: 2026-06-30能力
典型输入
典型输出
该技能可以做什么
- 编写 PyTorch 函数 docstring
- 使用原始字符串格式化 docstring
- 为函数参数添加类型标注
- 在 docstring 中添加数学公式
- 插入 Sphinx 交叉引用
- 添加注意事项与警告段落
- 在 docstring 中包含代码示例
- 编写原地操作与别名的文档
输入
- PyTorch 函数或方法源代码
- 函数参数名称与类型
- 返回值类型信息
- 用于交叉引用的相关 PyTorch 类与函数
输出
- Sphinx 格式的 docstring 文本
- 包含参数段落、示例和交叉引用的文档字符串
要求
- 可访问 PyTorch 代码库
- 支持 Sphinx/reStructuredText 格式