docstring-format

Google-style docstrings document functions with structured sections for Args, Returns, Raises, and Examples. This Skill automatically enforces and formats these sections across standard functions, async functions, class methods, and properties, ensuring consistency and readability throughout your codebase.

Google-style docstrings require Args (parameters), Returns (output), Raises (exceptions), Examples (usage), and Security Note sections where applicable. This Skill validates that each section is present, correctly formatted with proper type hints, and follows Google's documentation standards for Python code.

Yes. This Skill applies Google-style docstring enforcement to all functions, async functions, class methods, and properties in your code, validating section presence and format automatically. It integrates with tooling to auto-format docstrings and generate consistent documentation artifacts across your entire project.

No. This Skill handles async functions with built-in support for Security Note sections, automatically formatting examples and requirements for async code. It ensures type hints and section structure are correct without manual intervention.

Standardized Google-style docstrings improve code readability, maintainability, and team collaboration by ensuring consistent parameter documentation, return values, and error handling across all functions and classes. Automated enforcement prevents documentation drift and gaps.

Yes. This Skill enforces Google-style docstrings on class properties, including getters and setters, documenting their purpose, usage notes, and return types with the same standardized format applied to functions and methods.