docstring

Generate Google-style docstrings for Python modules, classes, and methods.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/Brajesh9373/Sorch_ai_performance --skill docstring-brajesh9373
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docstring
Source: https://github.com/Brajesh9373/Sorch_ai_performance/tree/main/pipecat/.claude/skills/docstring
Command: npx skills add https://github.com/Brajesh9373/Sorch_ai_performance --skill docstring-brajesh9373

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation and improvement of Google-style docstrings for Python modules and classes, ensuring code clarity and maintainability.

Core Features & Use Cases

  • Automated Docstring Generation: Creates docstrings for modules, classes, and methods based on code structure.
  • Style Enforcement: Adheres strictly to Google docstring conventions.
  • Use Case: A developer needs to document a new Python module. They can use this Skill to quickly generate well-formatted docstrings for all its components, saving time and ensuring consistency.

Quick Start

Use the docstring skill to document the VADAnalyzer class.

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 methods?

To generate Google-style docstrings for Python code, use an automated documentation tool that parses modules, classes, and methods to create standardized formatting for constructor parameters and public methods.

Can I automatically document Python dataclass fields and skip private methods?

Yes, automated Python docstring generation can document dataclass fields and public methods while intentionally skipping private methods and any code segments that already contain existing documentation.

What is the best way to ensure consistent code documentation across a new Python module?

The best way to ensure consistent code documentation across a Python module is to enforce strict Google docstring conventions through automated generation, which standardizes formatting for all classes, modules, and methods.

Does automated docstring generation overwrite existing documentation in Python code?

Automated docstring generation does not overwrite existing documentation, as the process specifically skips already documented code to preserve manually written explanations and prevent unintended formatting conflicts.

How do I format Python method parameters using Google docstring conventions?

To format Python method parameters using Google docstring conventions, an automated generator parses constructor arguments and method signatures to produce structured descriptions that adhere to specific Google style formatting guidelines.