Дом

Skill

Документация

nemo-rl-docs

NVIDIA/skills

Обновите файл docs/index.md и добавьте строк документации в стиле Google для изменений в документации NeMo-RL.

...Расширить все

Обновлено время 22 сентября 2026 г.

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

Правила оформления документации

Обновляйте файл docs/index.md

При добавлении нового документа в формате Markdown в папку docs/**/*.md или при переименовании файла Markdown убедитесь, что файл @docs/index.md обновлен и документ отображается в наиболее подходящем разделе.

Формат строк документации

Используйте docstrings в стиле Google для классов и функций. Их можно анализировать с помощью Sphinx.

Для интерфейсов, которые могут использоваться за пределами файла, предпочтительнее использовать docstrings, а не комментарии. Комментарии следует оставлять для кода внутри функции или интерфейсов, локальных для файла.

Документирование новых функций

При добавлении новой функции обновите или создайте документацию в каталоге 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.