generate-docstrings

Community

Auto-generate consistent docstrings for your code.

Authormvillmow
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Manually writing comprehensive and consistently formatted docstrings for functions and classes is a repetitive task that often gets overlooked, leading to undocumented code.

Core Features & Use Cases

  • Structured Docstring Creation: Helps write comprehensive docstrings following standard formats (Google, NumPy, reStructuredText).
  • API Documentation Support: Ensures docstrings contain all necessary information (parameters, returns, examples) for API documentation generation.
  • Use Case: When documenting a new public function, use this skill to generate a Google-style docstring template, prompting you to fill in parameters, return values, and usage examples.

Quick Start

Use the generate-docstrings skill to create a Google-style docstring for a Python matrix_multiply function, including args, returns, and an example.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: generate-docstrings
Download link: https://github.com/mvillmow/ProjectOdyssey/archive/main.zip#generate-docstrings

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.