Validate Python Docstrings Against Function Signatures With Pydoclint

---
name: "Validate Python Docstrings Against Function Signatures with pydoclint"
slug: "validate-python-docstrings-against-function-signatures-with-pydoclint"
description: "Check that Python docstrings stay consistent with parameters, returns, and raised exceptions as code evolves."
github_stars: 208
verification: "security_reviewed"
source: "https://github.com/jsh9/pydoclint"
author: "jsh9"
publisher_type: "individual"
category: "Code Quality & Review"
framework: "Multi-Framework"
tool_ecosystem:
  github_repo: "jsh9/pydoclint"
  github_stars: 208
---

# Validate Python Docstrings Against Function Signatures with pydoclint

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

## Prerequisites

Python, pydoclint, Python source tree

## Installation

Use the upstream install or setup path that matches your environment:
- pip install pydoclint
- pip install pydoclint[flake8]

Requirements and caveats from upstream:
- _Pydoclint_ is a Python docstring linter to check whether a docstring's
- Here is a comparison of linting time on some famous Python projects:
- also install _flake8_ to the current Python environment:

Basic usage or getting-started notes:
- [Google](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html),
- [2. Usage](#2-usage)
- To install only the native _pydoclint_ tooling, run this command:

- Source: https://github.com/jsh9/pydoclint
- Extracted from upstream docs: https://raw.githubusercontent.com/jsh9/pydoclint/HEAD/README.md

## Documentation

- https://jsh9.github.io/pydoclint/

## Source

- [Agent Skill Exchange](https://agentskillexchange.com/skills/validate-python-docstrings-against-function-signatures-with-pydoclint/)