docstring

Generate Google-style docstrings for Python modules and classes.

Updated Apr 11, 2026
One-click install
npx skills add https://github.com/ORANGECRAB13/vocareMVP --skill docstring-orangecrab13
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docstring
Source: https://github.com/ORANGECRAB13/vocareMVP/tree/main/.claude/skills/docstring
Command: npx skills add https://github.com/ORANGECRAB13/vocareMVP --skill docstring-orangecrab13

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically documents Python modules and classes using Google-style docstrings, aligning code documentation with project standards and reducing manual drafting time.

Core Features & Use Cases

  • Generates Google-style docstrings for modules and classes based on code structure.
  • Documents init methods and public interfaces to improve discoverability.
  • Supports input by module path or class name and provides disambiguation when multiple matches exist.

Quick Start

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

Frequently Asked Questions about docstring

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

FAQPage Schema
How do I generate Google-style docstrings for Python modules and classes?

To generate Google-style docstrings for Python, provide a module path or class name. The tool scans source files, parses signatures, and emits standardized documentation explaining purpose, parameters, and return values.

How do I automatically document Python __init__ methods and public interfaces?

Automatically document Python __init__ methods by targeting the class name. The generator scans the source code structure to document public interfaces and initialization methods, improving code discoverability and reducing manual drafting time.

Can I use auto-generation for Python documentation across large packages with multiple files?

Yes, Python docstring auto-generation supports projects of any size across packages. You provide a module path, and it scans the necessary source files to parse class and function signatures for standardized Google-style output.

What happens if there are multiple Python classes with the same name when generating documentation?

When multiple matches exist for a Python class name, the docstring generator provides disambiguation. This ensures you select the correct class before it parses signatures and emits the standardized Google-style documentation.

Does Python docstring generation work without external dependencies or components?

Yes, this Python docstring generation works as a standalone process with no external dependencies. It directly scans your source files to parse class and function signatures and emits standardized Google-style documentation.