NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI · #4459 most downloaded on PyPI
A Python docstring linter that checks arguments, returns, yields, and raises sections
Last release 2 days ago
02 Oct 2026
Release timing varies
gaps range from 1 weeks to 6 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
3 years old
96 releases · first in 2023
One column per quarter.
Don't check type hints for DOC103
Added baseline file integration and 2 options:
--generate-baseline True Generate baseline content, and write it to a
file specified from --baseline option path.--baseline <PATH> Specify path to file with baseline content.--config option, the default value is now pyproject.toml.Make flake8 an optional dependency
flake8 an optional dependencyAdded an option --require-yield-section-when-yielding-nothing (defaulting to False). When it's False, we don't need a "Yields" section when a function
--require-yield-section-when-yielding-nothing (defaulting
to False). When it's False, we don't need a "Yields" section when a
function yields None (https://github.com/jsh9/pydoclint/issues/79)Relaxed Generator/Iterator checking: stop enforcing the return annotation to be Generator if a function yields something
A bug with unparsing yield types
A bug with yields type checking
DOC403 code logicImproved handling of escape symbol (\) in docstrings
Improved
\) in docstrings
(https://github.com/jsh9/pydoclint/issues/73)Full diff
Improved handling of backticks or double backticks being used in type hints in docstrings
Improved
Full diff
Added checking of yield types (between function signature and the docstring's Yields section), as well as a corresponding violation: DOC404
DOC404Generator/Iterator and the
yield/return statements, as well as a corresponding violation: DOC405
(https://github.com/jsh9/pydoclint/issues/68)Fixed a bug where union-style return types (such as int | str) in Google-style docstrings cannot be correctly parsed
int | str) in
Google-style docstrings cannot be correctly parsed
(https://github.com/jsh9/pydoclint/issues/66)Fixed a broken URL that used to point to DOC103 notes
DOC103 notes
(https://github.com/jsh9/pydoclint/issues/61)Correctly handle potentially unacceptable type hint formats
Added handling of the NoReturn type annotation
NoReturn type annotation
(https://github.com/jsh9/pydoclint/issues/55)Improved algorithm to compare type hints, so that type hints are considered equal if their actual meanings are the same.
A documentation site to complement README
Pass --check-return-types option to flake8 plugin
--check-return-types option to flake8 plugin
(https://github.com/jsh9/pydoclint/pull/52)Fixed outdated naming of options --type-hints-in-docstring and --type-hints-in-signature
--type-hints-in-docstring and
--type-hints-in-signature (https://github.com/jsh9/pydoclint/issues/50)Fixed incorrect blocking of "sphinx" style in CLI arguments
Added support for the Sphinx docstring style
Fixed a bug (https://github.com/jsh9/pydoclint/issues/44) where tuple type annotation is incorrectly detected
Fixed false positive DOC402 when yield statements are in a block within a nested function
DOC402 when yield statements are in a block within
a nested function (https://github.com/jsh9/pydoclint/pull/42)return and raise statements are in a block
within a nested function (https://github.com/jsh9/pydoclint/pull/42)Fixed an issue where quotes in return annotations are not properly handled
False positives when checking abstract methods (partially tackles https://github.com/jsh9/pydoclint/issues/31)
False positive of DOC203 when --require-return-section-when-returning-None is False, the docstring has no return section, and the return annotation is
--require-return-section-when-returning-None is False, the docstring
has no return section, and the return annotation is None
(https://github.com/jsh9/pydoclint/pull/34)A new violation code, DOC203, which is about inconsistency between return types in the docstring and in the return annotation
Fixed a bug (https://github.com/jsh9/pydoclint/issues/19) in checking type hints when the function signature only contains star arguments
Replaced the --check-type-hint option with two new options: --type-hints-in-docstring and --type-hints-in-signature
--check-type-hint option with two new options:
--type-hints-in-docstring and --type-hints-in-signature
(https://github.com/jsh9/pydoclint/issues/19)A command line option --version to show the current version of pydoclint
--version to show the current version of pydoclint
(https://github.com/jsh9/pydoclint/pull/17)Fixed a bug where re-raising an exception was not handled properly
A typo in DOC103 error message that resulted in an invalid URL
DOC103 error message that resulted in an invalid URLA new option to allow no return section in the docstring if the function implicitly returns None
None (https://github.com/jsh9/pydoclint/issues/6)@property as its last decorator no longer need to have a
return section in the docstring (https://github.com/jsh9/pydoclint/pull/13)A new violation, DOC001, for errors in parsing docstrings
DOC001, for errors in parsing docstrings
(https://github.com/jsh9/pydoclint/pull/8)__init__() methods to have docstring (and when
users activate this option, check arguments and "Raises" in the docstring
of __init__() instead of in the class docstring)
(https://github.com/jsh9/pydoclint/pull/7)Callable[[int], str]Added support for Google-style docstrings
Fixed an issue where star arguments (\*, \*args, \*\*kwargs) were omitted
Initial release
Initial release
Your coding agent can read these notes before it upgrades. Set up the MCP server →