Docstring Check Orchestrator

A small utility module that runs docstring style checks programmatically with toggleable behaviors suitable for editor or CI integrations.

Capabilities

Rule selection and ignores

• Accepts explicit rule selectors and ignore lists to narrow or widen which docstring violations are reported. @test

Inline suppression control

• Supports a flag that either honors inline suppression comments or surfaces violations even when they appear. @test

Property decorator awareness

• Allows callers to provide additional decorator names that should be treated as properties for the purposes of missing-docstring checks. @test

Structured results for tooling

• Returns violations as structured data that includes rule code, message text, file path, and line number, with optional source excerpts when requested. @test

Implementation

@generates

API

from collections.abc import Iterable
from typing import Sequence

def run_docstring_checks(
    targets: Sequence[str],
    select: Sequence[str] | None = None,
    ignore: Sequence[str] | None = None,
    honor_inline_suppression: bool = True,
    property_decorators: Sequence[str] | None = None,
    include_source: bool = False,
) -> list[dict]:
    """
    Run docstring validation on the given files or directories and return structured violations.
    """

Dependencies { .dependencies }

pydocstyle { .dependency }

Provides docstring style checking capabilities for Python code.