Pydoclint

Latest version: v0.5.10

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

Scan your dependencies

Page 2 of 10

0.5.4

- Added

- An option `--should-document-private-class-attributes` (if False, private
class attributes should not appear in the docstring)
- An option `--treat-property-methods-as-class-attributes` (if True,
`property` methods are treated like class attributes and need to be
documented in the class docstring)

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.5.3...0.5.4

0.5.3

- Changed

- Added DOC604 & 605 test cases
- Improved DOC605 error message

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.5.2...0.5.3

0.5.2

- Changed

- Pinned to a higher version (0.0.9) of docstring_parser_fork
- Relaxed class attribute checking logic
- When a class has no docstring, no DOC6xx violations will be reported
- When a class has a short docstring (and
`--skip-checking-short-docstrings`) is set to `True`, no DOC6xx
violations will be reported

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.5.1...0.5.2

0.5.1

- Fixed

- Fixed a bug in unparsing annotations when checking class attributes
- Fixed a bug in checking class attributes where there are no attributes in
class def or in docstring

- Changed

- Used a dedicated "attribute" section for Sphinx-style docstrings

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

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

Page 2 of 10

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.