darglint

What it is and what it does

Darglint is a linter that validates whether docstrings accurately describe the functions and methods they document. It parses docstrings in Google, Sphinx, or Numpy style and compares them against the actual code—checking that documented parameters, return types, exceptions, and yields match what the implementation actually does. The tool runs from the command line and can be configured to ignore specific errors, adjust strictness levels (short/long/full), and customize error message formats.

The project is currently in maintenance mode: the original maintainer no longer works with Python regularly and is not adding significant new features, though bug fixes and pull requests are still accepted. It has no runtime dependencies, making installation straightforward. The tool is useful for teams that want to enforce documentation accuracy as part of their code quality pipeline, though ongoing maintenance and feature development should not be expected.

Use it for:

• Enforce that docstrings document all function parameters and return values before code review.
• Catch outdated docstrings when function signatures change during refactoring.
• Validate exception documentation matches the actual exceptions a function can raise.
• Integrate into CI/CD pipelines to fail builds when docstrings drift from implementation.
• Configure strictness levels to allow simple one-liners while fully checking complex functions.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Darglint is a docstring linter that checks whether function and method docstrings match their actual implementation, supporting Google, Sphinx, and Numpy style formats.

Yes, if you need docstring validation and accept maintenance-mode status. The tool is stable, has no dependencies, and works reliably for its core purpose. Install it if your team uses Google, Sphinx, or Numpy docstring styles and wants automated checks for documentation accuracy. Do not expect new features or rapid bug fixes; evaluate whether the current feature set meets your needs before adopting.

Install

darglint on PyPI

pip install darglint

uv add darglint

poetry add darglint

Installing darglint

Before you install

Low install friction with no runtime dependencies. However, the project is in maintenance mode with no active development—the maintainer no longer works with Python regularly and unlikely to add significant new features, though pull requests are accepted.

License in practice

MIT license is permissive, allowing use in both open-source and commercial projects with minimal restrictions.

Quickstart

pip install darglint

# Check a single file
darglint myfile.py

# Check all Python files in a directory
find . -name "*.py" | xargs darglint

Requires Python 3.6 or later; configuration file (.darglint, setup.cfg, or tox.ini) with [darglint] section needed for non-default behavior.

Verify before relying

• Whether the tool integrates with modern linting workflows (flake8, pre-commit) beyond what the description excerpt covers.
• Current state of compatibility with Python 3.10+ despite classifier support only through 3.9.
• Whether configuration via .darglint, setup.cfg, or tox.ini still works reliably in current tooling ecosystems.

Package facts

Evidence: darglint-1.8.1-py3-none-any.whl

Keywords: documentation, linter, development

Tags

More Quality Assurance packages