docstring

Generate Google-style docstrings for Python modules and classes.

Updated Apr 7, 2026

Search Tags:#automation #documentation #python #code-quality #static-analysis #docstring #google-style

Ready to run

npx skills add https://github.com/Nabilhassan12345/voice-ai-workspace --skill docstring-nabilhassan12345

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docstring
Source: https://github.com/Nabilhassan12345/voice-ai-workspace/tree/main/pipecat/.claude/skills/docstring
Command: npx skills add https://github.com/Nabilhassan12345/voice-ai-workspace --skill docstring-nabilhassan12345

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Document Python modules and classes with Google-style docstrings to standardize documentation and improve maintainability.

Core Features & Use Cases

Automatically generate module and class docstrings following Google style.
Analyze a module path or class name to locate relevant code segments and produce documentation.
Enforce consistency across a codebase by providing structured docstrings that accompany code.

Quick Start

Provide a module path or class name to generate Google-style docstrings for the identified code.

Frequently Asked Questions about docstring

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

FAQPage Schema

How do I automatically generate Google-style docstrings for Python classes?▼

The Skill analyzes a provided module path or class name to automatically generate standardized Google-style docstrings for Python classes. It enforces documentation coverage across public APIs, __init__ constructors, and dataclass-like configurations while preserving existing complete docstrings.

What is the best way to enforce docstring coverage across a Python project?▼

The best way to enforce docstring coverage across a Python project is to use an automation tool that generates standardized Google-style docstrings for modules and classes. This ensures uniform documentation across public APIs and constructors while preserving existing complete docstrings.

Can I auto-document Python dataclass-like configurations and constructors?▼

Yes, you can auto-document Python dataclass-like configurations and __init__ constructors by passing the module path or class name. The Skill specifically enforces docstring coverage for these code segments to maintain consistency.

Does this docstring generator preserve existing complete Python docstrings?▼

Yes, the docstring generator preserves existing complete Python docstrings. It analyzes the module path or class name and only applies standardized Google-style documentation to undocumented public APIs, constructors, and dataclass-like configurations without overwriting finished work.

What input is needed to generate Python module documentation using static analysis?▼

To generate Python module documentation using static analysis, you need to provide a module path or a specific class name as input. The tool then locates the relevant code segments and outputs standardized Google-style docstrings.

When should I use an automated docstring generator for Python code?▼

You should use an automated docstring generator for Python code when you need to standardize documentation across a large codebase and improve maintainability. It is particularly useful for enforcing consistent Google-style docstrings across public APIs and dataclass-like configurations.