집

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 경로에 새로운 마크다운 문서가 추가되거나 마크다운 파일의 이름이 변경된 경우, @docs/index.md가 업데이트되고 해당 문서가 가장 적합한 섹션에 표시되도록 해야 합니다.

Docstring 형식

클래스와 함수에는 Google 스타일의 docstring을 사용하십시오. 이는 Sphinx에서 파싱할 수 있습니다.

파일 외부에서 사용될 수 있는 인터페이스의 경우, 주석보다는 docstring을 우선적으로 사용하십시오. 주석은 함수 내부의 코드나 해당 파일에 국한된 인터페이스에만 사용해야 합니다.

새로운 기능 문서화

새로운 기능이 추가되면, 해당 기능과 가장 밀접하게 관련된 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.