Skip to content

Commit

Permalink
Disallow TODO comments (#410)
Browse files Browse the repository at this point in the history
Closes: #409

Disallowing TODO comments makes it easier to spot unfinished work
(either locally or in CI pipelines)

Longer term "todo like" comments should use a LATER keyword.
  • Loading branch information
fohrloop authored Sep 26, 2024
1 parent aa026da commit f0e730a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
5 changes: 5 additions & 0 deletions docs/source/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## wakepy x.x.x
🗓️ unreleased

### 👷 Maintenance
- Disallow TODO comments ([#410](https://github.com/fohrloop/wakepy/pull/410))

## wakepy 0.10.1
🗓️ 2024-09-20
Expand Down
20 changes: 16 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -151,10 +151,22 @@ exclude = [
[tool.ruff.lint]
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
# W505: doc-line-too-long. Ref: https://docs.astral.sh/ruff/rules/doc-line-too-long/
# W291: trailing-whitespace. Ref: https://docs.astral.sh/ruff/rules/trailing-whitespace/
select = ["E", "F", "W505", "W291"]
select = [
# E: pycodestyle
"E",
# F: Pyflakes
"F",
# W505: doc-line-too-long. Ref: https://docs.astral.sh/ruff/rules/doc-line-too-long/
"W505",
# W291: trailing-whitespace. Ref: https://docs.astral.sh/ruff/rules/trailing-whitespace/
"W291",
# Disallow TODO (these should be either fixed before merging, or
# alternatively, use a LATER tag. In addition, disallow XXX, FIXME and HACK
"FIX001",
"FIX002",
"FIX003",
"FIX004",
]
ignore = []
# Allow autofix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
Expand Down

0 comments on commit f0e730a

Please sign in to comment.