家

Skill

ドキュメント

nemo-rl-docs

NVIDIA/skills

docs/index.md を更新し、NeMo-RL のドキュメントの変更点について、Google スタイルの docstring を記述する。

...すべて拡張します

更新された時間 2026年9月22日

# markdown # documentation conventions # google style docstrings # nemo rl # sphinx

ドキュメントの記述規則

docs/index.md を最新の状態に保つ

docs/**/*.mdの下に新しい Markdown ドキュメントが追加された場合、または Markdown ファイルの名前が変更された場合は、@docs/index.md を更新し、そのドキュメントが最適なセクションに表示されるようにしてください。

Docstring の形式

クラスや関数には、Google スタイルの docstring を使用してください。これらは Sphinx によって解析可能です。

ファイルの外で使用される可能性のあるインターフェースについては、コメントよりもドキュメント文字列を優先してください。コメントは、関数内のコードや、そのファイルに限定されたインターフェースにのみ使用するようにしてください。

新機能のドキュメント化

新機能が追加された場合は、その機能に最も近いdocs/ディレクトリ内のドキュメントを更新するか、新しいドキュメントを作成してください。既存のドキュメントを参照して最適な場所を確認してください。該当するドキュメントが存在しない場合は、新しいドキュメントを作成し、@docs/index.md に追加してください。

バグ修正やCI関連の変更については、ドキュメントの変更は不要です。

GitHubで見る

---
name: nemo-rl-docs
description: Update docs/index.md and write Google-style docstrings for NeMo-RL documentation changes.
license: Apache-2.0
---

# Documentation Conventions

## Keep docs/index.md Up to Date

When a new markdown doc is added under `docs/**/*.md` or a markdown file is renamed, ensure that @docs/index.md is updated and the document appears in the most appropriate section.

## Docstring Format

Use [Google style](https://google.github.io/styleguide/pyguide.html) docstrings for classes and functions. These are parseable by Sphinx.

For interfaces that may be used outside a file, prefer docstrings over comments. Comments should be reserved for code within a function or interfaces local to a file.

## Document New Features

When a new feature is added, update or create documentation in the `docs/` directory that most closely matches the feature. Look at existing docs to find the best fit — if none exists, create a new doc and add it to @docs/index.md.

Documentation changes are **not required** for bug fixes or CI-related changes.