| 名称 | nemo-rl-docs |
| 开源协议 | Apache-2.0 |
| 描述 | “NeMo-RL的文档约定。涵盖docs/index.md的更新和docstring格式。不要用于：错误修复、测试修复、依赖升级、重构、CI/CD更改、性能调优，或任何不涉及编写或更新文档的任务。” when_to_use: 添加或更新文档；添加新的markdown文件；审查docstring；‘docs/index.md’、‘docstring格式’、‘Sphinx’、‘我在哪里添加文档’，在代码审查期间。 |
文档约定
保持docs/index.md最新
当在docs/**/*.md下添加新的markdown文档或重命名markdown文件时，确保@docs/index.md已更新，并且文档出现在最合适的部分。
Docstring格式
类和函数使用Google风格的docstring。这些可被Sphinx解析。
对于可能在文件外部使用的接口，优先使用docstring而不是注释。注释应保留给函数内的代码或文件本地接口。
记录新功能
当添加新功能时，在docs/目录中更新或创建与功能最匹配的文档。查看现有文档以找到最佳位置——如果不存在，创建新文档并将其添加到@docs/index.md。
不要求为错误修复或CI相关更改提供文档更改。