pydoclint is a Python docstring linter designed to check whether sections such as arguments, returns, yields, and raises correctly match a function’s signature or implementation.
It’s intended for developers who want stricter, more reliable docstring validation in Python projects, and it supports NumPy, Google, and Sphinx-style docstrings while fitting into existing linting and pre-commit workflows.
This is free and open source software.
Key Features
- Very fast docstring linting with published comparisons against darglint on large Python projects.
- Supports NumPy, Google, and Sphinx-style docstrings.
- Can be used for gradual adoption with baseline support to record existing violations.
- Provides categorized DOC0xx to DOC6xx violation codes covering parsing issues, arguments, returns, yields, raises, constructors, and class attributes.
- Includes configuration options for tuning checks to match team conventions and preferences.
- Supports inline suppression in native mode with
# noqa: DOCxxx.
Website: github.com/jsh9/pydoclint/
Support:
Developer: jsh9
License: MIT License
pydoclint is written in Python. Learn Python with our recommended free books and free tutorials.
Related Software
| Python Linters | |
|---|---|
| Ruff | Extremely fast Python linter and code formatter |
| ty | Fast Python type checker |
| Mypy | Static type checker for Python |
| Bandit | Find security issues in Python code |
| Pylint | Static code analyser |
| wemake-python-styleguide | Flake8 plugin |
| pycodestyle | Check Python code against style conventions in PEP 8 |
| Pyflakes | Checks Python source files for errors |
| Vulture | Find dead code |
| Pyrefly | Fast type checker and language server |
| Flake8 | Wrapper around PyFlakes and pycodestyle |
| Beartype | Near-real-time hybrid runtime-static type-checker |
| Radon | Computes various metrics from Python code |
| Pyright | Full-featured, standards-compliant static type checker |
| cython-lint | Lint Cython files |
| basedpyright | Fork of pyright |
| Refurb | Modernize Python codebases |
| Pylama | Code audit tool for Python |
| Prospector | Brings together the functionality of other Python analysis tools |
| deptry | Check for dependency issues |
| Fixit | Highly configurable linting framework |
| Pyroma | Rates how well a Python project compiles |
| pydoclint | Python docstring linter |
| YALA | Yet Another Linter Aggregator |
Read our verdict in the software roundup.
 Explore our carefully curated directory of recommended free and open source software, covering every major software category.The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form. |
Please read our Comment Policy before commenting.