Repository navigation
build(ruff): enable D (google convention) and N - #21
Conversation
Refs furedea/agent-config#74 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Refs furedea/agent-config#74 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
|
@codex review |
Codex Review Summary: ❌ FailedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
| "PERF", | ||
| "E", | ||
| "W", | ||
| "D", |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
|
Review summary: I found no blocking issues (P0/P1: 0). This PR turns on ruff
Tests: these are config-only lint changes, so they don't need new tests. Note: I couldn't run ruff locally (it isn't installed in the review environment). This review is based on reading the code. 🤖 Generated with Claude Code |
Google style has no rule for these. __init__ arguments belong in the class docstring. Magic methods are defined by their protocol. Refs furedea/agent-config#74 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
|
@codex review |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
Review summary No blocking issues found. I didn't post any inline comments.
🤖 Generated with Claude Code |
Refs furedea/agent-config#74
段階 1B(template-python): ruff の
D(google convention,tests は対象外)とNを有効化した.ANN201/ANN202はignoreに無いので変更なし.対応表
D(pydocstyle,google)agents/skills/python-style/references/code_style.md:84D)pyproject.tomlの[tool.ruff.lint]selectと[tool.ruff.lint.pydocstyle]N(pep8-naming)agents/skills/python-style/references/code_style.md:25snake_case(Classes:UpperCamelCase)N)pyproject.tomlの[tool.ruff.lint]selectD104 / D105 / D107 を ignore する理由(ユーザー判断)
D104(package の__init__),D105(magic method),D107(__init__)はignoreに加えた.D100〜D103は有効のまま.__init__の引数はクラスの docstring に書く違反数(この repo の設定で測定)
コミット
build(ruff): enable D (google convention) and N: 設定のみdocs(main): add module and function docstrings:src/main.pyに実質のある docstring を追加.passは docstring と重複するため削除修正ごとの設計上の理由
src/main.py): モジュールの役割(テンプレートの entry point)を述べた.名前の言い換えではないmain): 「何もしない雛形である」という呼び出し側が知るべき契約を書いた.引数・戻り値・例外が無い関数なので,これ以上の節は不要passの削除:docstring だけで本体が成立するため.抑止(noqa,ignore)や改名は使っていない確認(nix develop)
ruff check,ruff format --check,ty check,pytestがすべて通過🤖 Generated with Claude Code