Docstring Lint Hook

A command-line hook that lint-checks Python docstrings via AST analysis, honoring project-level validation settings discovered from repository config files.

Capabilities

Lint selected files

• Running the command with Python file paths validates their docstrings and exits with status code 0 when no issues are found, printing a concise success message. @test

Discover project configuration

• When a pyproject.toml in the project root enables a required-docstring check, invoking the command on a file missing a docstring reports a line-numbered validation entry (including the error code) and exits with status code 1. @test

Override configuration path

• Supplying an explicit --config pointing to a config file that ignores the required-docstring check allows the same file to pass validation and exit with status code 0. @test

Respect exclude patterns

• If the discovered configuration excludes a path (e.g., tests/.*), invoking the command on both an excluded file and a valid non-excluded file lints only the latter and exits with status code 0. @test

Implementation

@generates

API

def main(argv: list[str] | None = None) -> int:
    """
    Entry point for the docstring lint hook CLI.
    """

Dependencies { .dependencies }

numpydoc { .dependency }

Provides AST-based docstring linting with configuration discovery suitable for pre-commit style hooks.