- Fixed - A bug with tuple decomposition in docstrings - Full diff - https://github.com/jsh9/pydoclint/compare/0.6.3...0.6.4
0.6.3
- Added - Added `DOC504` and a config option `--should-declare-assert-error-if-assert-statement-exists`. If this option is True and a function has an `assert` statement, an `AssertError` declaration is required in the docstring. Otherwise `DOC504` is raised. (This changes the behavior introduced in v0.6.1.) - Added a new config option `--ignore-private-args` (default to `False`) - Changed - Canceled the ignoring of `LN002` violation in flake8 config in tox - Fix a typo in maximum line length setting in flake8 config in tox - Full diff - https://github.com/jsh9/pydoclint/compare/0.6.2...0.6.3
0.6.2
- Fixed - An issue where no error was thrown when the user does not supply a path - A bug where `--only-attrs-with-ClassVar-are-treated-as-class-attrs` is not properly passed to the visitor in the flake8 mode - Full diff - https://github.com/jsh9/pydoclint/compare/0.6.1...0.6.2
0.6.1
- Changed - Now if a function as an `assert` statement, an `AssertError` declaration is by default required in the docstring's "Asserts" section (if relevant config options to check raises/assertions are turned on) - Full diff - https://github.com/jsh9/pydoclint/compare/0.6.0...0.6.1
0.6.0
- Added - A new violation code, `DOC003`, to detect docstring style mismatch (when docstrings are written in the style different from specified) - Full diff - https://github.com/jsh9/pydoclint/compare/0.5.19...0.6.0
0.5.19
- Fixed - False positive DOC405 and DOC201 when we have bare return statements together with `yield` statements - Added - A new config option `--should-document-star-arguments` (if `False`, star arguments such as `*args` and `**kwargs` should not be documented in the docstring) - A pre-commit step to check that "Full diff" is always added in CHANGELOG.md - Full diff - https://github.com/jsh9/pydoclint/compare/0.5.18...0.5.19