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,

• 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