Skill Detail

Validate Python Docstrings Against Function Signatures with pydoclint

Check that Python docstrings stay consistent with parameters, returns, and raised exceptions as code evolves.

Code Quality & ReviewMulti-Framework
Code Quality & Review Multi-Framework Security Reviewed
โญ 208 GitHub stars
INSTALL WITH ANY AGENT
npx skills add agentskillexchange/skills --skill validate-python-docstrings-against-function-signatures-with-pydoclint Copy
Works best when you want a reusable capability, not another fragile one-off prompt.
At a glance
Tools required
Python, pydoclint, Python source tree
Install & setup
Install with pip, then run it over the package or changed files you want to verify: pip install pydoclint && pydoclint path/to/package
Author
jsh9
Publisher
Individual
Last updated
Apr 18, 2026
Quick brief

This skill uses pydoclint for a very specific documentation-integrity workflow. The agent compares Python docstrings to live function signatures and flags drift in parameters, return values, and documented exceptions so teams can catch stale API docs during review.

How it works

What this skill actually does

Invoke it when code changes faster than its inline documentation and reviewers need a precise consistency check. Use general documentation tools when creating prose or broader style guidance. Use this skill when the real job is signature-to-docstring validation.

The scope boundary is strict docstring consistency checking. It is not a broad documentation platform, generic Python linter, or package reference card.