auto-docstring-rules

Name: auto-docstring-rules
Availability: InStock
Author: dltHub

Enforce Google-style Python docstrings and inline field documentation.

5.7k|578|Updated Jan 26, 2022

Search Tags:#python #code-quality #docstrings #docstring #lint #google-style #field-docstrings

Ready to run

npx skills add https://github.com/dlt-hub/dlt --skill auto-docstring-rules-dlt-hub

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: auto-docstring-rules
Source: https://github.com/dlt-hub/dlt/tree/main/.claude/skills/auto-docstring-rules
Command: npx skills add https://github.com/dlt-hub/dlt --skill auto-docstring-rules-dlt-hub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Enforces Google-style docstrings across Python code, ensuring consistent, readable documentation for functions, classes, and modules, and provides clear guidance on inline field docstrings.

Core Features & Use Cases

Enforces Google-style docstrings throughout the codebase, including Args, Returns, and Raises blocks.
Supports inline field docstrings to document configuration attributes and class fields as demonstrated in examples.
Highlights and avoids common anti-patterns to improve code readability and maintainability.

Quick Start

Run the auto-docstring-rules checker on your Python project to enforce Google-style docstrings and inline field documentation.

Frequently Asked Questions about auto-docstring-rules

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

FAQPage Schema

How do I enforce Google-style docstrings across a Python codebase?▼

Enforce Google-style docstrings by running an automated checker that validates Args, Returns, and Raises blocks across modules, classes, and public APIs to ensure consistent Python documentation.

What is the best way to document Python class fields and configuration attributes?▼

Document Python class fields using inline field docstrings, which provide clear guidance and ensure configuration attributes are consistently documented alongside standard Google-style docstrings.

How do I flag common Python docstring anti-patterns during code reviews?▼

Flag common Python docstring anti-patterns during code reviews by applying automated docstring rules that highlight formatting inconsistencies and enforce documented Google-style formats.

Can I use this docstring linter for both short and full Python docstring forms?▼

Yes, the docstring linter supports both short and full Python docstring forms, validating required Args, Returns, and Raises sections while flagging missing or malformed documentation.

Does this tool require any external dependencies to check Python docstrings?▼

No external dependencies are required to check Python docstrings, as the tool operates natively to enforce Google-style formats and inline field documentation without additional installations.