
Your docstrings are lying — docvet 1.14 catches them
A 2024 study by Macke & Doyle found that incorrect documentation degrades LLM task success by 22.6 percentage points. Missing documentation? No statistically significant effect. Your AI coding assistant performs worse with wrong docs than with no docs at all. That's the gap docvet fills. And with v1.14, it closes the gap further — checking not just whether your docstrings exist, but whether they match your code . What Changed Parameter Agreement Checks Two new rules — missing-param-in-docstring and extra-param-in-docstring — compare function signatures against Args: sections, parameter by parameter. You know the drill: you rename retries to max_retries across a refactor, update every call site, and forget the docstring. Now docvet catches it: src/client.py:47: missing-param-in-docstring Function 'connect' has parameters not documented in Args: max_retries [required] Handles positional-only params (PEP 570), keyword-only, self / cls exclusion, and both Google and Sphinx styles. Reverse
Continue reading on Dev.to Python
Opens in a new tab


