Does it handle complex data types and exceptions?

Absolutely. It is designed to document parameters, return values, and specifically call out exceptions in a dedicated 'Raises' section.

Why should I use this instead of writing docstrings manually?

It ensures strict consistency across your entire project, follows best practices like PEP 257, and significantly reduces the time spent on manual documentation tasks.

Can it generate examples for my functions?

Yes, the skill analyzes your function's signature and logic to provide practical usage examples directly within the docstring.

What documentation styles does this skill support?

The skill supports the most popular industry standards including Google, NumPy, and reStructuredText formats.

Docstring Generator

Name: Docstring Generator
Author: majiayu000

bymajiayu000

•

144

•

Learning & Documentation

Generates comprehensive, standardized docstrings for functions and classes to improve code readability and API documentation.

The Docstring Generator skill automates the creation of professional documentation for codebases, supporting industry-standard formats like Google, NumPy, and reStructuredText. It analyzes function logic, parameters, and return types to produce clear summaries, detailed argument descriptions, and usage examples, ensuring consistent documentation quality across projects and facilitating the seamless generation of automated API documentation.

Key Features

01Generates practical, context-aware usage examples for functions

02144 GitHub stars

03Identifies and documents exceptions and constraints in a standardized 'Raises' section

04Supports Google, NumPy, and reStructuredText documentation styles

05Automatically extracts and documents function parameters and return types

06Ensures consistent documentation structure across multi-file projects

Use Cases

01Adding documentation to legacy codebases or previously undocumented functions

02Preparing code for automated documentation generation tools like Sphinx or Doxygen

03Standardizing docstring formats across a team-based software project

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add majiayu000/claude-skill-registry generation

For use in Claude.ai and ChatGPT

Download Skill