Pydoclint

Latest version: v0.6.4

Safety actively analyzes 723158 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 5 of 12

0.5.0

- Added

- Added checks for class attributes
- This functionality checks class attributes against the "Attributes"
section of the docstring
- There is a new config option, `--check-class-attributes` (or `-cca`),
which defaults to `True`. Therefore, this breaks backward compatibility.
- To maintain backward compatibility, set `--check-class-attributes` to
`False`
- Options like `--check-arg-order`, `--arg-type-hints-in-signature`, and
`--arg-type-hints-in-docstring` are still effective in checking class
attributes

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.4.2...0.5.0

0.4.2

- Changed

- Improved the violation message of DOC403 to remind users to add a return
annotation

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.4.1...0.4.2

0.4.1

- Fixed

- A bug where using double quotes in Literal type (such as `Literal["foo"]`
could produce a false positive `DOC203` violation.
- Removed useless argument `--src`

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.4.0...0.4.1

0.4.0

- Changed

- Improved the violation message of DOC105: the arguments with inconsistent
type hints are now shown in the violation message to make violation
correction much easier

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.3.10...0.4.0

0.3.10

- Added

- A new config option `--show-filenames-in-every-violation-message` (or
`-sfn`), which makes it more convenient to jump to the corresponding line
in IDEs by clicking on the violation message in the terminal

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.3.9...0.3.10

0.3.9

- Fixed

- False positive violation `DOC203` when there is no docstring return section
for methods with `property` decorator

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.3.8...0.3.9

Page 5 of 12

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.