python-code-documentation-guidelines

What problem does it solve?

This skill standardizes Python documentation by enforcing Google-style docstrings and clear inline comments for new or touched code, reducing ambiguity and onboarding time.

Core Features & Use Cases

• Enforce Google-style docstrings for functions, methods, and modules (Args, Returns, Raises with types).
• Require class docstrings that describe the class's responsibility, not just its name.
• Promote clear comments and concise single-line docstrings to enhance readability.
• Provide guidance for TODOs related to renames with a reference to UN-17829 when appropriate.

Quick Start

Apply Google-style docstrings and inline comments to new or touched Python files.