codecov[bot]
commented
2 months ago Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 92.30%. Comparing base (
252e737) to head (61cd53e).
Closed renovate[bot] closed 1 month ago
codecov[bot]
commented
2 months ago All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 92.30%. Comparing base (
252e737) to head (61cd53e).
This PR contains the following updates:
0.4.2->0.5.40.5.6(+1)Note: The
pre-commitmanager in Renovate is not supported by thepre-commitmaintainers or community. Please do not report any problems there, instead create a Discussion in the Renovate repository if you have any questions.Release Notes
jsh9/pydoclint (jsh9/pydoclint)
### [`v0.5.4`](https://togithub.com/jsh9/pydoclint/blob/HEAD/CHANGELOG.md#054---2024-07-14) [Compare Source](https://togithub.com/jsh9/pydoclint/compare/0.5.3...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 ### [`v0.5.3`](https://togithub.com/jsh9/pydoclint/blob/HEAD/CHANGELOG.md#053---2024-06-26) [Compare Source](https://togithub.com/jsh9/pydoclint/compare/0.5.2...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 ### [`v0.5.2`](https://togithub.com/jsh9/pydoclint/blob/HEAD/CHANGELOG.md#052---2024-06-26) [Compare Source](https://togithub.com/jsh9/pydoclint/compare/0.5.1...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 ### [`v0.5.1`](https://togithub.com/jsh9/pydoclint/blob/HEAD/CHANGELOG.md#051---2024-06-24) [Compare Source](https://togithub.com/jsh9/pydoclint/compare/0.5.0...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 ### [`v0.5.0`](https://togithub.com/jsh9/pydoclint/blob/HEAD/CHANGELOG.md#050---2024-06-22) [Compare Source](https://togithub.com/jsh9/pydoclint/compare/0.4.2...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.0Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.