Python Docstring Rules

Use this skill when reviewing or writing Python docstrings.

Purpose and scope

• Use Google-style docstrings.
• Focus on public Python modules, classes, functions, and methods.
• Keep docstrings compact, specific, and easy to scan.

Request changes when

• a public API has no docstring;
• the summary line is vague or inaccurate;
• arguments, returns, or intentionally raised exceptions are undocumented;
• a non-trivial public API needs an example but does not have one.

Required structure