Skip to content

Commit

Permalink
pyproject.toml: Run ruff on basic examples, ignore docstring
Browse files Browse the repository at this point in the history
- Only exclude examples/advanced from ruff, to start running ruff on the basic examples.
- Ignore docstring errors in the example folder.

Both can be revisited in the future.
  • Loading branch information
EwoutH committed Oct 16, 2024
1 parent 4e6e640 commit ffe565b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ path = "mesa/__init__.py"
# Hardcode to Python 3.10.
# Reminder to update mesa-examples if the value below is changed.
target-version = "py310"
extend-exclude = ["docs", "build", "examples"]
extend-exclude = ["docs", "build", "examples/advanced"] # TODO: Remove examples/advanced

[tool.ruff.lint]
select = [
Expand Down Expand Up @@ -148,5 +148,8 @@ extend-ignore = [
"ISC001", # ruff format asks to disable this feature
"S311", # Standard pseudo-random generators are not suitable for cryptographic purposes
]
# Ignore all docstring errors in examples
per-file-ignores = {"examples/*"= ["D"]}

[tool.ruff.lint.pydocstyle]
convention = "google"

0 comments on commit ffe565b

Please sign in to comment.