Skip to content

build(ruff): enable D (google convention) and N #21

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.

Sign up for GitHub

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

Merged
furedea merged 3 commits into from
Nov 10, 2026
Merged

build(ruff): enable D (google convention) and N #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0d93a7
build(ruff): enable D (google convention) and N
furedea Nov 9, 2026
4f8639d
docs(main): add module and function docstrings
furedea Nov 9, 2026
5b9622a
build(ruff): ignore D104, D105 and D107
furedea Nov 10, 2026
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
10 changes: 9 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ select = [
"PERF",
"E",
"W",
"D",

@github-actions github-actions Bot Nov 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P3: Enabling D (even with convention = "google") keeps D206 and D300 active. Ruff's formatter documents both as conflicting with ruff format, so ruff format will now print a "rules may cause conflicts" warning. The ignore list already turns off W191/E111/E114/E117 for this exact reason, so for consistency consider also adding "D206" and "D300" there.

@furedea-agent furedea-agent Bot Nov 9, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refuted with a measurement: with this config, ruff check and ruff format --check -v (ruff 0.15.11) print no "rules may cause conflicts" warning, and ruff check --select D206,D300 reports 0 violations. Ruff only warns when the formatter settings actually conflict with the rule. Here indent-style = "space" matches D206 and quote-style = "double" matches D300, so nothing is ignored. W191/E111/E114/E117 are ignored in this repo for other reasons (the 2-space TOML/Nix style), not because D206/D300 conflict.

"DOC",
"N",
"F",
"PGH",
"PLC",
Expand All @@ -114,14 +116,20 @@ ignore = [
"B008",
"A002",
"A003",
"D104",
"D105",
"D107",
"W191",
"E111",
"E114",
"E117",
]

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["PLR0913"]
"tests/**" = ["D", "PLR0913"]

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

[tool.ruff.lint.mccabe]
max-complexity = 10
Expand Down
5 changes: 4 additions & 1 deletion src/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
"""Entry point of the template application."""


def main() -> None:
pass
"""Run the application; the template does nothing yet."""


if __name__ == "__main__":
Expand Down
Loading