python-docstring

Generate Python docstrings in Google, NumPy, and Sphinx styles.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Python projects frequently suffer from inconsistent or missing docstrings, making maintenance and onboarding harder; this skill automates the creation of clear, style-consistent docstrings that document purpose, parameters, returns, and exceptions.

Core Features & Use Cases

  • Supports Google, NumPy, and Sphinx styles; can generate function, class, and module docstrings.
  • Generates Args, Returns, Examples sections with parameter types and descriptions.
  • Helps enforce PEP 257 and project documentation standards for code reviews and API docs.

Quick Start

Provide a Python function signature or class and receive a ready-to-use docstring following a chosen style.

Frequently Asked Questions about python-docstring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Python docstrings that follow Google style conventions?

To generate Google style Python docstrings, provide a function or class signature to receive a ready-to-use docstring with properly formatted Args, Returns, and Examples sections that ensures adherence to PEP 257 documentation standards.

What is the difference between NumPy and Sphinx docstring formats for Python functions?

NumPy and Sphinx docstring formats differ in section layout and indentation; this skill supports both, enabling automated creation of style-consistent Python docstrings that document parameters, returns, and exceptions across functions, classes, and modules.

Can I automatically add Args and Returns sections to existing Python code?

Yes, you can automatically add Args and Returns sections to existing Python code by providing the function signature to generate docstrings with parameter types, descriptions, and examples following your chosen Google, NumPy, or Sphinx style.

Does this Python docstring generator support module and class level documentation?

Yes, this Python docstring generator supports module and class level documentation, applying established conventions across functions, methods, classes, and modules with multi-line and single-line formats that comply with PEP 257.

How do I enforce PEP 257 documentation standards during Python code reviews?

You enforce PEP 257 documentation standards during code reviews by generating clear, style-consistent Python docstrings that include required sections like Args, Returns, and Examples, providing validation notes to ensure project documentation compliance.