Google Style Python Docstring

This skill provides expertise in writing Python documentation and comments according to the Google Python Style Guide. Proper documentation ensures code is understandable by both humans and automated tools like pydoc and pytype.

Core Instructions

1. Prioritize Intent Over Mechanics: Focus on why a function or class exists and how it should be used. Avoid mechanically repeating the code's logic.
2. Standard Format: Use the three-double-quote """ format for all docstrings.
3. Structured Sections: Use explicit sections for Args:, Returns:, and Raises: to maintain a consistent structure across the project.
4. Consistency is Key: Whether you choose imperative or descriptive style, ensure it's consistent within each file.

Audit Checklist

When reviewing or writing documentation, use the following checklist:

• Does every module, class, and public function have a docstring?
• Does the first line consist of a concise, one-line summary terminated by a period?
• Is there a blank line after the summary if the description continues?
• Are all parameters listed in the Args: section with correct indentation?