google-docstring-assistant

Generate Google-style Python docstrings with Args, Returns, and Examples sections.

109|40|Updated Jul 24, 2017
One-click install
npx skills add https://github.com/dmitriiweb/extract-emails --skill google-docstring-assistant
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: google-docstring-assistant
Source: https://github.com/dmitriiweb/extract-emails/tree/main/.codex/skills/google-docstring-assistant
Command: npx skills add https://github.com/dmitriiweb/extract-emails --skill google-docstring-assistant

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Writing consistent Python docstrings that follow the Google style guide is time-consuming and error-prone; this skill automates the creation of clear, structured docstrings to improve code readability and maintainability.

Core Features & Use Cases

  • Generate docstrings for functions, classes, and modules with standard sections like Args, Returns, Raises, and Examples.
  • Enforce Google-style formatting, including section order, indentation, and concise descriptions, while allowing optional sections such as Attributes and Todo for modules and classes.
  • Provide references and examples to guide teams in adopting consistent documentation practices within Python projects.

Quick Start

Generate a Google-style docstring for a Python function or module.

Frequently Asked Questions about google-docstring-assistant

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Google-style Python docstrings for my functions?

To generate Google-style Python docstrings, provide your function, class, or module code. The tool outputs structured documentation with standard sections like Args, Returns, and Examples, aligned with the Google Python Style Guide.

What sections are required in a Google style Python docstring?

Google style Python docstrings require Args, Returns, and Examples sections to ensure consistent code documentation. Optional sections like Attributes and Todo can also be generated for modules and classes to improve readability.

Can I use this to document Python classes and modules, not just functions?

Yes, you can document Python classes and modules. It enforces standard Google-style formatting across all project components, adding optional sections like Attributes for classes and modules to improve onboarding and maintainability.

What is the best way to standardize Python code documentation across a team?

The best way to standardize Python code documentation is to enforce a consistent style guide. This tool automates generating Google-style docstrings with standard section ordering and indentation, ensuring team-wide readability and onboarding consistency.

Does this enforce indentation and section order for Python docstrings?

Yes, it enforces Google-style formatting, including strict section order and indentation. It references specific docstring rules to ensure concise descriptions and consistent formatting aligned with the Google Python Style Guide.