SuperAPI AI 工具集

nemo-rl-docs

编程与开发

查看项目

更新于 10-16 02:33

技能介绍

用途:这是 NeMo-RL 项目的文档编写约定,用于指导贡献者按统一规范维护文档,而非代码修复或工程改动。

主要能力与要求:

  1. 保持 docs/index.md 最新。当在 docs/**/*.md 下新增 markdown 文档或重命名 markdown 文件时,需同步更新 @docs/index.md,并把文档放到最合适的章节。
  2. Docstring 格式。类与函数使用 Google 风格 docstring,以便 Sphinx 解析。
  3. 注释与 docstring 的取舍。可能被文件外部使用的接口优先写 docstring 而非注释;注释应保留给函数内部代码或仅限文件内使用的接口。
  4. 记录新功能。新增功能时,在 docs/ 目录中更新或创建与该功能最匹配的文档;先查看现有文档寻找最合适的位置,若没有则新建文档并加入 @docs/index.md。

适用场景:新增或重命名文档、为新功能补充说明、统一 docstring 风格。

限制:bug 修复或 CI 相关改动不需要文档变更。资料未提供具体安装命令、代码示例、收费或平台信息。