Does it document private methods?

By default, the skill skips private methods (starting with an underscore) and simple dunder methods to keep documentation focused on the public-facing API.

What docstring style does this skill use?

It exclusively uses the Google Python Style Guide for docstrings, including specific sections for Args, Returns, and Raises to ensure maximum readability.

Does it overwrite my existing documentation?

No, the skill is designed to skip functions, classes, and modules that already have complete, correctly formatted docstrings.

Can I document a specific class without knowing its file path?

Yes, you can provide just the class name. The skill will search your source directory and ask for confirmation if multiple matches are found.

Python Google Docstring Generator

Name: Python Google Docstring Generator
Author: pipecat-ai

bypipecat-ai

•

10,844

•

Learning & Documentation

Automates the creation of Google-style Python docstrings for modules, classes, and methods to ensure consistent documentation.

This skill streamlines the documentation process for Python projects by generating standardized Google-style docstrings. It intelligently scans modules or specific classes to identify missing documentation in constructors, public methods, dataclasses, and enums while preserving existing high-quality comments. By enforcing strict formatting rules and action-oriented language, it ensures that codebase documentation remains professional, consistent, and compatible with documentation generators like Sphinx.

Key Features

01Comprehensive documentation of constructors, public methods, and type hints

02Intelligent class search within project source directories

03Smart detection to skip private methods and existing complete docstrings

04Specialized formatting for dataclasses, configuration fields, and enums

05Automated Google-style docstring generation for modules and classes

0610,844 GitHub stars

Use Cases

01Standardizing documentation across a large Python codebase or library

02Quickly adding docstrings to new modules or complex class hierarchies

03Ensuring consistent API documentation for public-facing Python frameworks

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add pipecat-ai/pipecat docstring

For use in Claude.ai and ChatGPT

Download Skill