nemo-rl-docs

ドキュメントの規約

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

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

Docstring の形式

クラスと関数の Docstring には、Google スタイルを使用してください。Sphinx で解析できます。

ファイルの外部から使用される可能性があるインターフェースには、コメントより Docstring を優先してください。コメントは、関数内のコードやファイル内でのみ使用されるインターフェースに限定してください。

新機能をドキュメント化する

新機能を追加した場合は、docs/ ディレクトリ内に、その機能に最も合ったドキュメントを更新または作成してください。既存のドキュメントを確認して最適なものを探し、適切なものがなければ新しいドキュメントを作成して @docs/index.md に追加してください。

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