Python Docstring Style

Write Python docstrings and inline comments matching the flashdreams house style — SPDX header, one-line module docstring, Google-style function docstrings (Args/Returns/Raises), PEP 257 attribute docstrings on dataclass/class fields *and on module-level constants*, double-backticks for code references, imperative first sentences, and signpost-style inline block comments (kept, not stripped, on a tightening pass). Use when authoring or editing any .py file under flashdreams/, when adding a new module/class/function/field/constant, when polishing comments, or when the user asks about docstring or comment style.

NVIDIA Updated 23k repo stars
FlashDreams

File contents

nvidia/flashdreams commit 6b7397d617

Frequently asked questions

npx get-skill add nvidia/python-docstring-style