Heim

Skill

Dokumentation

nemo-rl-docs

NVIDIA/skills

Aktualisiere die Datei „docs/index.md“ und verfasse Docstrings im Google-Stil für die Änderungen an der NeMo-RL-Dokumentation.

...Alle erweitern

Zeit aktualisiert 22. September 2026

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

Konventionen für die Dokumentation

Halten Sie „docs/index.md“ auf dem neuesten Stand

Wenn ein neues Markdown-Dokument unter „docs/**/*.md“ hinzugefügt oder eine Markdown-Datei umbenannt wird, stellen Sie sicher, dass „@docs/index.md“ aktualisiert wird und das Dokument im am besten geeigneten Abschnitt erscheint.

Format von Docstrings

Verwenden Sie Docstrings im Google-Stil für Klassen und Funktionen. Diese können von Sphinx geparst werden.

Bei Schnittstellen, die außerhalb einer Datei verwendet werden können, sollten Docstrings gegenüber Kommentaren bevorzugt werden. Kommentare sollten für Code innerhalb einer Funktion oder für Schnittstellen reserviert bleiben, die lokal auf eine Datei beschränkt sind.

Neue Funktionen dokumentieren

Wenn eine neue Funktion hinzugefügt wird, aktualisieren oder erstellen Sie im Verzeichnis „docs/“ die Dokumentation, die am besten zu dieser Funktion passt. Sehen Sie sich die vorhandenen Dokumente an, um die passende Kategorie zu finden – falls keine vorhanden ist, erstellen Sie ein neues Dokument und fügen Sie es zu @docs/index.md hinzu.

Bei Fehlerbehebungen oder CI-bezogenen Änderungen sind keine Änderungen an der Dokumentation erforderlich.

Auf GitHub ansehen

---
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.