docstring

Generate Google-style docstrings for Python modules and classes.

Updated Mar 3, 2026
One-click install
npx skills add https://github.com/Gorillaa-ai-org/pipecat --skill docstring-gorillaa-ai-org
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docstring
Source: https://github.com/Gorillaa-ai-org/pipecat/tree/main/.claude/skills/docstring
Command: npx skills add https://github.com/Gorillaa-ai-org/pipecat --skill docstring-gorillaa-ai-org

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of clear, consistent docstrings for Python modules and classes using Google-style conventions.

Core Features & Use Cases

  • Document Python modules and classes, including init methods and public APIs.
  • Generate module, class, and method docstrings that conform to Google style, including parameter and return descriptions.
  • Use case: accelerate onboarding of new contributors by providing complete, standards-compliant documentation across a codebase.

Quick Start

Provide the module path or class name to generate Google-style docstrings for the target Python 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 classes and modules?

To generate Google-style docstrings for Python code, provide the module path or class name to automatically produce module, class, and method documentation with parameter and return descriptions. This ensures consistent code readability across projects.

What is the best way to document Python __init__ methods and public APIs?

Documenting Python __init__ methods and public APIs is best handled by applying Google-style docstring conventions across the codebase. This generates standardized documentation with clear parameter and return descriptions for maintainable code.

Does this docstring generator work with existing Python codebases?

Yes, the docstring generator works with existing Python codebases by applying Google-style conventions to modules and classes. It targets public APIs and __init__ methods to produce consistent documentation across your project.

Can I automate Python module documentation for new contributor onboarding?

You can automate Python module documentation for onboarding by generating complete, standards-compliant Google-style docstrings across a codebase. This provides clear module, class, and method parameter descriptions to accelerate new contributor understanding.

What are the limitations when applying Google-style docstrings to Python code?

A limitation of applying Google-style docstrings is that your Python modules must already follow Google-style conventions for the tool to effectively generate module, class, and method documentation with accurate parameter descriptions.