Skip to content

Commit 7c9e933

Browse files
feat: Enhance Ruff per-file ignores with documentation links (#1779)
* Add Ruff rule links for per-file ignores * Update backend/pyproject.toml --------- Co-authored-by: Arkadii Yakovets <[email protected]>
1 parent c064b4b commit 7c9e933

File tree

1 file changed

+54
-12
lines changed

1 file changed

+54
-12
lines changed

backend/pyproject.toml

Lines changed: 54 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -144,18 +144,60 @@ ignore = [
144144
select = ["ALL"]
145145

146146
[tool.ruff.lint.per-file-ignores]
147-
"**/__init__.py" = ["D104", "F401"]
148-
"**/admin.py" = ["D100", "D101", "D104"]
149-
"**/rest/v1/*.py" = ["ARG001", "B008", "D106"]
150-
"**/apps.py" = ["D100", "D101", "D104"]
151-
"**/graphql/**/nodes.py" = ["D106"]
152-
"**/graphql/nodes/*.py" = ["D106"]
153-
"**/graphql/queries/*.py" = ["N805"]
154-
"**/management/commands/*.py" = ["D101", "D102", "T201"]
155-
"**/migrations/*.py" = ["D100", "D101", "D104", "E501"]
156-
"**/models.py" = ["D106"]
157-
"**/models/*.py" = ["D106"]
158-
"**/tests/**/*.py" = ["D100", "D101", "D102", "D103", "D107", "PLR2004", "S101"]
147+
"**/__init__.py" = [
148+
"D104", # https://docs.astral.sh/ruff/rules/undocumented-public-package/
149+
"F401" # https://docs.astral.sh/ruff/rules/unused-import/
150+
]
151+
"**/admin.py" = [
152+
"D100", # https://docs.astral.sh/ruff/rules/undocumented-public-module/
153+
"D101", # https://docs.astral.sh/ruff/rules/undocumented-public-class/
154+
"D104" # https://docs.astral.sh/ruff/rules/undocumented-public-package/
155+
]
156+
"**/apps.py" = [
157+
"D100", # https://docs.astral.sh/ruff/rules/undocumented-public-module/
158+
"D101", # https://docs.astral.sh/ruff/rules/undocumented-public-class/
159+
"D104" # https://docs.astral.sh/ruff/rules/undocumented-public-package/
160+
]
161+
"**/graphql/**/nodes.py" = [
162+
"D106" # https://docs.astral.sh/ruff/rules/undocumented-public-nested-class/
163+
]
164+
"**/graphql/nodes/*.py" = [
165+
"D106" # https://docs.astral.sh/ruff/rules/undocumented-public-nested-class/
166+
]
167+
"**/graphql/queries/*.py" = [
168+
"N805" # https://docs.astral.sh/ruff/rules/invalid-first-argument-name-for-method/
169+
]
170+
"**/management/commands/*.py" = [
171+
"D101", # https://docs.astral.sh/ruff/rules/undocumented-public-class/
172+
"D102", # https://docs.astral.sh/ruff/rules/undocumented-public-method/
173+
"T201" # https://docs.astral.sh/ruff/rules/print/
174+
]
175+
"**/migrations/*.py" = [
176+
"D100", # https://docs.astral.sh/ruff/rules/undocumented-public-module/
177+
"D101", # https://docs.astral.sh/ruff/rules/undocumented-public-class/
178+
"D104", # https://docs.astral.sh/ruff/rules/undocumented-public-package/
179+
"E501" # https://docs.astral.sh/ruff/rules/line-too-long/
180+
]
181+
"**/models.py" = [
182+
"D106" # https://docs.astral.sh/ruff/rules/undocumented-public-nested-class/
183+
]
184+
"**/models/*.py" = [
185+
"D106" # https://docs.astral.sh/ruff/rules/undocumented-public-nested-class/
186+
]
187+
"**/rest/v1/*.py" = [
188+
"ARG001", # https://docs.astral.sh/ruff/rules/unused-function-argument/
189+
"B008", # https://docs.astral.sh/ruff/rules/function-call-in-default-argument/
190+
"D106" # https://docs.astral.sh/ruff/rules/undocumented-public-nested-class/
191+
]
192+
"**/tests/**/*.py" = [
193+
"D100", # https://docs.astral.sh/ruff/rules/undocumented-public-module/
194+
"D101", # https://docs.astral.sh/ruff/rules/undocumented-public-class/
195+
"D102", # https://docs.astral.sh/ruff/rules/undocumented-public-method/
196+
"D103", # https://docs.astral.sh/ruff/rules/undocumented-public-function/
197+
"D107", # https://docs.astral.sh/ruff/rules/undocumented-public-init/
198+
"PLR2004", # https://docs.astral.sh/ruff/rules/magic-value-comparison/
199+
"S101" # https://docs.astral.sh/ruff/rules/assert/
200+
]
159201

160202
[build-system]
161203
build-backend = "poetry.core.masonry.api"

0 commit comments

Comments
 (0)