Skip to content

Commit 2ac253a

Browse files
authored
Disable the new check-class-attributes check in pydoclint 0.5.3 (#288)
We use a different way to document class attributes, so this check is not useful for us.
2 parents 327879b + 1660756 commit 2ac253a

File tree

9 files changed

+13
-0
lines changed

9 files changed

+13
-0
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,4 @@
5454
- Make the `nox-cross-arch-all` job fail if any `nox-cross-arch` matrix job fails.
5555
- Fix credentials not being passed to the `test-installation` job in the CI workflow.
5656
- Make sure credentials are configured for all jobs that check out the repository in the CI workflow.
57+
- Disable the new `check-class-attributes` check in pydoclint 0.5.3, as we use a different way to document class attributes.

cookiecutter/migrate.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,5 +241,10 @@ EOF
241241
manual_step "Please make sure to remove or uncomment the options to the 'gh-action-setup-git' action in the '.github/workflows/ci.yaml'"
242242
grep -n "TODO(cookiecutter)" -- .github/workflows/ci.yaml .github/containers/test-installation/Dockerfile
243243

244+
echo "========================================================================"
245+
246+
echo "Disabling new pydoclint's check-class-attributes check in "
247+
sed -i "/^allow-init-docstring/a check-class-attributes = false" pyproject.toml
248+
244249
# Add a separation line like this one after each migration step.
245250
echo "========================================================================"

cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ check-yield-types = false
148148
arg-type-hints-in-docstring = false
149149
arg-type-hints-in-signature = true
150150
allow-init-docstring = true
151+
check-class-attributes = false
151152

152153
[tool.pylint.similarities]
153154
ignore-comments = ['yes']

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ check-yield-types = false
146146
arg-type-hints-in-docstring = false
147147
arg-type-hints-in-signature = true
148148
allow-init-docstring = true
149+
check-class-attributes = false
149150

150151
[tool.pylint.similarities]
151152
ignore-comments = ['yes']

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ check-yield-types = false
122122
arg-type-hints-in-docstring = false
123123
arg-type-hints-in-signature = true
124124
allow-init-docstring = true
125+
check-class-attributes = false
125126

126127
[tool.pylint.similarities]
127128
ignore-comments = ['yes']

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ check-yield-types = false
117117
arg-type-hints-in-docstring = false
118118
arg-type-hints-in-signature = true
119119
allow-init-docstring = true
120+
check-class-attributes = false
120121

121122
[tool.pylint.similarities]
122123
ignore-comments = ['yes']

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ check-yield-types = false
121121
arg-type-hints-in-docstring = false
122122
arg-type-hints-in-signature = true
123123
allow-init-docstring = true
124+
check-class-attributes = false
124125

125126
[tool.pylint.similarities]
126127
ignore-comments = ['yes']

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ check-yield-types = false
118118
arg-type-hints-in-docstring = false
119119
arg-type-hints-in-signature = true
120120
allow-init-docstring = true
121+
check-class-attributes = false
121122

122123
[tool.pylint.similarities]
123124
ignore-comments = ['yes']

tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ check-yield-types = false
122122
arg-type-hints-in-docstring = false
123123
arg-type-hints-in-signature = true
124124
allow-init-docstring = true
125+
check-class-attributes = false
125126

126127
[tool.pylint.similarities]
127128
ignore-comments = ['yes']

0 commit comments

Comments
 (0)