pydoclint
A Python docstring linter that checks arguments, returns, yields, and raises sections
Decision gist · record as of 2026-08-14
Yes. Pydoclint is actively maintained, has no known vulnerabilities, installs with minimal friction, and is permissively licensed. It fills a clear need for fast, accurate docstring linting across multiple styles. Install it if your team values documentation consistency and wants to catch docstring-signature mismatches automatically; the speed advantage over alternatives like darglint is substantial for large codebases.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or higher; Python 3.8 and 3.9 are not supported.
- Low install friction with three lightweight runtime dependencies (click, docstring_parser_fork, tomli).
- Active maintenance with a release 42 days ago and 220 repository stars.
License · maintenance · safety
MIT (permissive) — MIT license (permissive) allows use in commercial and private projects with minimal restrictions; attribution is required but no copyleft obligations apply.
last release 2026-07-03 (42 days) · last repo commit 2026-07-03 · 220 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 872,369 downloads/mo, #4,844 on PyPI
Alternatives
Verify before relying
pip install pydoclint
pydoclint <FILE_OR_FOLDER>
# Or as a flake8 plugin:
pip install pydoclint[flake8]
flake8 --select=DOC <FILE_OR_FOLDER>- Whether the package's claimed performance advantage (thousands of times faster than darglint) holds across typical project sizes and configurations.
- How well the three supported docstring styles (numpy, Google, Sphinx) cover real-world codebases and whether style deviations are acceptable for your team.
What it is and what it does
Pydoclint is a command-line docstring linter that parses function signatures and implementations, then checks whether the docstring's documented sections (parameters, return values, exceptions) are accurate and complete. It supports three major docstring conventions—numpy, Google, and Sphinx—and can run as a standalone tool, a flake8 plugin, or a pre-commit hook. The package is designed for speed and can process large codebases in seconds rather than minutes or hours.
The linter detects mismatches between what a function actually does and what its docstring claims: missing or undocumented parameters, incorrect return type documentation, and unhandled exceptions. It complements pydocstyle (which checks formatting and structure) rather than replacing it. Configuration is flexible, supporting inline suppression via `# noqa` comments, baseline generation for gradual adoption, and multiple style options. The tool requires Python 3.10 or higher and depends on click, docstring_parser_fork, and tomli.
Use it for
- Enforce consistent docstring quality across a team's codebase by catching mismatches between function signatures and their documentation.
- Integrate docstring linting into CI/CD pipelines via flake8 or pre-commit hooks to catch documentation drift before code review.
- Gradually adopt strict docstring standards in legacy projects using the baseline feature to log existing violations without blocking new commits.
- Validate that all function parameters, return values, and exceptions are properly documented in numpy, Google, or Sphinx style.
- Speed up large-scale docstring audits on projects like numpy or scikit-learn where traditional linters would take hours.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Pydoclint is actively maintained, has no known vulnerabilities, installs with minimal friction, and is permissively licensed. It fills a clear need for fast, accurate docstring linting across multiple styles. Install it if your team values documentation consistency and wants to catch docstring-signature mismatches automatically; the speed advantage over alternatives like darglint is substantial for large codebases.
Install
pydoclint on PyPI
Before you install
Low install friction with three lightweight runtime dependencies (click, docstring_parser_fork, tomli). Active maintenance with a release 42 days ago and 220 repository stars. Requires Python 3.10 or higher.
Requires Python 3.10 or higher; Python 3.8 and 3.9 are not supported.
License in practice
MIT license (permissive) allows use in commercial and private projects with minimal restrictions; attribution is required but no copyleft obligations apply.
Quickstart
pip install pydoclint
pydoclint <FILE_OR_FOLDER>
# Or as a flake8 plugin:
pip install pydoclint[flake8]
flake8 --select=DOC <FILE_OR_FOLDER>Verify before relying
- Whether the package's claimed performance advantage (thousands of times faster than darglint) holds across typical project sizes and configurations.
- How well the three supported docstring styles (numpy, Google, Sphinx) cover real-world codebases and whether style deviations are acceptable for your team.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesclickdocstring_parser_forktomli |
| Maintenance | Actively maintained 42 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 872,369 / month, #4,844 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | License :: OSI Approved :: MIT LicenseProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: Only |
Evidence: pydoclint-0.9.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “docstring linter”
- pydoclintPydoclint is a Python docstring linter that validates whether…
- darglintDarglint is a docstring linter that checks whether function and…
- docsigLints Python function and method signatures to ensure their…
Give your agent the search over MCP, or paste the wish link into any chat.
More Quality Assurance packages
Coverage.py measures which lines of Python code are executed during test runs, reporting coverage percentages and identifying untested code paths.
Install it if you want to measure test completeness or enforce coverage thresholds in your project.
Ruff is a Python linter and code formatter written in Rust that combines linting, formatting, and code fixing into a single tool, replacing Flake8, Black, isort, and related utilities.
Pexpect spawns and controls interactive console applications by sending input and matching output patterns, automating tasks that would otherwise require manual interaction.
Black reformats Python source code to a consistent style by parsing entire files and rewriting them according to an opinionated, deterministic set of rules, eliminating manual formatting decisions.
pytest-xdist distributes pytest tests across multiple CPU cores or machines to speed up test execution, with the simplest usage being `pytest -n auto` to spawn workers equal to available CPUs.
Install it if your test suite takes long enough that parallelization would save meaningful time.
Validates AWS CloudFormation templates in YAML or JSON format against resource provider schemas and best practices, checking property values and configuration correctness.
Install it if you work with CloudFormation templates.
See also darglint · pydocstyle · flake8-docstrings · flake8-rst-docstrings · docsig · numpydoc · yamllint · tclint · sphinx-lint · pylama