pydocstyle is a static analysis tool for checking compliance with
Python docstring conventions.
pydocstyle supports most of PEP 257 out of the box, but it should not
be considered a reference implementation.
The framework for checking docstring style is flexible, and custom
checks can be easily added, for example to cover NumPy docstring
conventions.
Provides
Requires
License
MIT
Changelog
* Wed Apr 29 2026 Steve Kowalik <steven.kowalik@suse.com>
- Add patch avoid-nesting-error.patch:
* Avoid error with the nesting function.
* Tue Jan 30 2024 Steve Kowalik <steven.kowalik@suse.com>
- Skip two broken tests with Python 3.12.
* Tue Jun 13 2023 ecsos <ecsos@opensuse.org>
- Add %{?sle15_python_module_pythons}
* Thu Jan 19 2023 Ben Greiner <code@bnavigator.de>
- Update to 6.3.0
* Add ignore-self-only-init option by @thejcannon in #560
- Release 6.2.3
* Fix decorator parsing for async functions by @cdce8p in #577
* fix: do not pass file names with pre-commit by @yajo in #610
- Release 6.2.2
* Fix false positive of google convention missing args
descriptions by @stinovlas in #619
- Release 6.2.1
* Add https protocol on websites at the README.rst by @realFranco
in #611
* Use tomllib/tomli for reading .toml configs by @mgorny in #608
- Release 6.2.0
* Exempt properties from D401 by @TomFryers in #546
* Add support for Python 3.10 by @hugovk in #554
* Add D419: Add and switch to "Docstring is empty" error code by
@thejcannon in #559
* Allow for hanging indent when documenting args in Google style
by @rmorshea in #564
* Fix match option to only consider basename when given a path
argument by @oczkoisse in #550
- Drop integration-tests-invocation.patch
* Thu Jul 14 2022 Ben Greiner <code@bnavigator.de>
- Remove old pathlib extra package build requirement. It is
included in the stdlib since Python 3.4
* Tue Apr 12 2022 Ben Greiner <code@bnavigator.de>
- Tests require the extra dependency toml which is not pulled in
automatically by pytest anymore
* Thu Apr 07 2022 pgajdos@suse.com
- python-mock is not required for build
* Sat Mar 26 2022 Dirk Müller <dmueller@suse.com>
- update 6.1.1:
* Split ``--source`` by lines instead of by characters (#536).
* Enable full toml configuration and pyproject.toml (#534).
* Support for Python 3.5 has been dropped (#510).
* Add flag to disable `# noqa` comment processing in API (#485).
* Methods, Functions and Nested functions that have a docstring now throw D418 (#511).
* Methods decorated with @overload no longer reported as D102 (#511).
* Functions and nested functions decorated with @overload no longer reported as D103 (#511).
* Treat "package" as an imperative verb for D401 (#356).
* Fix the parsing of decorated one line functions (#499).
* Methods, Functions and Nested functions that have a docstring now throw D418 (#511).
* Methods decorated with @overload no longer reported as D102.
* Functions and nested functions decorated with @overload no longer reported as D103.
* Sat Oct 10 2020 Arun Persaud <arun@gmx.de>
- update to version 5.1.1:
* Bug Fixes
+ Fix IndexError crash on one-line backslashed docstrings (#506).
- changes from version 5.1.0 :
* New Features
+ Skip function arguments prefixed with _ in D417 check (#440).
* Bug Fixes
+ Update convention support documentation (#386, #393)
+ Detect inner asynchronous functions for D202 (#467)
+ Fix indentation error while parsing class methods (#441).
+ Fix a bug in parsing Google-style argument description. The bug
caused some argument names to go unreported in D417 (#448).
+ Fixed an issue where skipping errors on module level docstring
via #noqa failed when there where more prior comments (#446).
+ Support backslash-continued descriptions in docstrings (#472).
+ Correctly detect publicity of modules inside directories (#470,
[#494]).
* Wed May 20 2020 Petr Gajdos <pgajdos@suse.com>
- %python3_only -> %python_alternative
Files
/etc/alternatives/pydocstyle
/usr/bin/pydocstyle