This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
1.1.0
Major Updates
- pydocstyle is no longer a single file. This might make it difficult for some users to just add it to their project, but the project has reached certain complexity where splitting it into modules was necessary (#200).
New Features
- Added the optional error codes D212 and D213, for checking whether the summary of a multi-line docstring starts at the first line, respectively at the second line (#174).
- Added D404 - First word of the docstring should not be “This”. It is turned off by default (#183).
- Added the ability to ignore specific function and method docstrings with inline comments:
“# noqa” skips all checks.
“# noqa: D102,D203” can be used to skip specific checks.
Bug Fixes
- Fixed an issue where file paths were printed in lower case (#179, #181).
- The error code D300 is now also being reported if a docstring has uppercase literals (R or U) as prefix (#176).
- Fixed a bug where an all error was reported when all was imported from another module with a different name (#182, #187).
- Fixed a bug where raise X from Y syntax caused pydocstyle to crash (#196, #200).