docvet 1.14: Parameter Agreement, Reverse Checks, and Trivial Docstring Detection

[Alberto-Codes]

docvet v1.14.0

Biggest enrichment expansion yet — six new rules focused on docstring truthfulness, not just presence.

Highlights

• Parameter agreement checks — missing-param-in-docstring and extra-param-in-docstring compare signatures against Args sections. Supports Google, Sphinx, positional-only (PEP 570), keyword-only, and *args/**kwargs exclusion.
• Reverse enrichment — extra-raises-in-docstring, extra-yields-in-docstring, extra-returns-in-docstring catch docstrings claiming behavior the code doesn't exhibit. Uses scope-aware AST walking.
• Trivial docstring — flags summaries that echo the symbol name without adding information (def get_user → """Get user.""").
• Missing deprecation — detects warnings.warn(DeprecationWarning) or @deprecated (PEP 702) without a docstring notice.
• Missing return type (opt-in) — flags Returns: with no type when there's no return annotation.
• Undocumented init params (opt-in) — catches __init__ with parameters but no Args: section.

Install / Upgrade

pip install docvet==1.14.1

Param agreement and reverse checks are on by default. Opt-in rules:

[tool.docvet.enrichment]
require-return-type = true
require-init-params = true

What's Next

• Semantic verification: is what the docstring says about parameters accurate?
• Expanding multi-style support across all rule categories

Full changelog: https://github.com/Alberto-Codes/docvet/releases/tag/v1.14.0