Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix missing config option onlyAttrsWithClassVarAreTreatedAsClassAttrs #219

Merged
merged 1 commit into from
Feb 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Change Log

## [Unpublished]
## [0.6.2] - 2025-02-17

- 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] - 2025-02-16

Expand Down
7 changes: 7 additions & 0 deletions pydoclint/flake8_entry.py
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,10 @@ def run(self) -> Generator[tuple[int, int, str, Any], None, None]:
'--treat-property-methods-as-class-attributes',
self.treat_property_methods_as_class_attributes,
)
onlyAttrsWithClassVarAreTreatedAsClassAttrs = self._bool(
'--only-attrs-with-ClassVar-are-treated-as-class-attrs',
self.only_attrs_with_ClassVar_are_treated_as_class_attrs,
)
shouldDocumentStarArguments = self._bool(
'--should-document-star-arguments',
self.should_document_star_arguments,
Expand Down Expand Up @@ -390,6 +394,9 @@ def run(self) -> Generator[tuple[int, int, str, Any], None, None]:
treatPropertyMethodsAsClassAttributes=(
treatPropertyMethodsAsClassAttributes
),
onlyAttrsWithClassVarAreTreatedAsClassAttrs=(
onlyAttrsWithClassVarAreTreatedAsClassAttrs
),
shouldDocumentStarArguments=shouldDocumentStarArguments,
checkStyleMismatch=checkStyleMismatch,
style=self.style,
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = pydoclint
version = 0.6.1
version = 0.6.2
description = A Python docstring linter that checks arguments, returns, yields, and raises sections
long_description = file: README.md
long_description_content_type = text/markdown
Expand Down