关于 nemo-rl-docs
nemo-rl-docs 是用于维护项目文档规范的仓库技能,涵盖文档索引、Google 风格文档字符串,以及新增功能时的文档更新要求。
主要功能
- 01维护 docs/index.md
- 02使用 Google 风格文档字符串
- 03在 docs/ 中记录新功能
适用场景
- 01新增或重命名 Markdown 文档
- 02编写供文件外使用的类或函数接口
- 03添加功能时更新文档
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ nvidia/ skills --skill nemo-rl-docs安装后在 Claude Code 中输入/nemo-rl-docs确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
BENCHMARK.mdskill-card.mdskill.oms.sigevals/evals.json详细介绍
文档规范
保持 docs/index.md 为最新状态
在 docs/**/*.md 下新增 Markdown 文档或重命名 Markdown 文件时,请确保更新 @docs/index.md,并将文档放在最合适的章节中。
Docstring 格式
类和函数的 Docstring 请使用 Google 风格。Sphinx 可以解析这种格式。
对于可能在文件外部使用的接口,优先使用 Docstring,而非注释。注释应仅用于函数内部的代码或文件局部接口。
记录新功能
新增功能时,请在 docs/ 目录中更新或创建与该功能最匹配的文档。请查看现有文档,找到最合适的位置;如果没有合适的文档,请创建新文档并将其添加到 @docs/index.md。
修复 Bug 或进行 CI 相关更改时,无需更新文档。
评论
支持 Markdown