Can I document specific classes or entire modules?

Yes, you can provide either a module path or a specific class name. If a class name is provided, the skill will search the source directory to find the correct file.

Does it document private methods?

By default, the skill skips private methods starting with an underscore and simple dunder methods to focus on the clarity of the public API.

What styles of docstrings does this skill support?

This skill specifically follows the Google style guide for Python docstrings, including structured sections for Args, Returns, and Raises.

Does this skill overwrite my existing documentation?

No, the skill is designed to skip code that already contains complete docstrings following the project style, only adding or improving missing or incomplete documentation.

Google Python Docstrings

Name: Google Python Docstrings
Author: Gorillaa-ai-org

byGorillaa-ai-org

0•

学习与文档

Standardizes Python source code documentation using the Google style guide to ensure consistent and professional module, class, and method descriptions.

This skill streamlines the process of documenting Python projects by automatically generating or updating docstrings according to Google style conventions. It intelligently identifies modules, classes, public methods, and dataclasses, ensuring that arguments, return types, and exceptions are clearly defined using action-oriented language. By prioritizing purpose over implementation and maintaining existing high-quality documentation, it helps developers maintain a professional codebase that is easy to navigate and compatible with documentation tools like Sphinx.

主要功能

01Intelligent search for specific class names within project source directories.

02Automated Google-style docstring generation for modules, classes, and methods.

03Selective documentation that skips private methods and simple dunder methods.

04Specific formatting support for dataclasses, enums, and event handlers.

050 GitHub stars

06Smart preservation of existing complete documentation to avoid redundant changes.

使用场景

01Ensuring new modules meet project-wide documentation standards before code review.

02Generating public API documentation for parameters, return values, and exceptions.

03Standardizing documentation across a large Python codebase or framework.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add gorillaa-ai-org/pipecat docstring

For use in Claude.ai and ChatGPT