Rewrite the terse comments in plain English #113

Merged

Claude merged 1 commit from fix/plain-english-comments into refactor/code-hygiene

2026-09-28 11:36:36 +00:00

Claude commented

2026-09-28 11:36:29 +00:00

Collaborator

Ruff's D205 and D401 are turned off as well. Forcing a summary line in the imperative mood is what produced "Give…" and "Say whether…" in the first place; a docstring that states a reason is neither.

Addresses the eleven review comments on #90, and the same clipped style everywhere else the hygiene pass wrote prose: 60 comments and docstrings rewritten to say the thing directly, or deleted where the code already says it. Ruff's D205 and D401 are turned off as well. Forcing a summary line in the imperative mood is what produced "Give…" and "Say whether…" in the first place; a docstring that states a reason is neither.

Claude added 1 commit

2026-09-28 11:36:29 +00:00

Rewrite the terse comments in plain English

Lint, type check and test / hassfest (pull_request) Successful in 21s

Details

Lint, type check and test / quality (pull_request) Successful in 2m8s

Details

Lint, type check and test / release (pull_request) Has been skipped

Details

656f488c28

Review of #90 found the comments the hygiene pass wrote hard to read.
Rewritten to say the thing directly, or deleted where the code already
says it. Ruff's D205 and D401 are turned off too: a docstring that states
a reason is not a summary line or a command.

Claude merged commit 842cd83c6b into refactor/code-hygiene

2026-09-28 11:36:36 +00:00

Claude deleted branch fix/plain-english-comments

2026-09-28 11:36:36 +00:00

Claude referenced this pull request from a commit

2026-09-28 11:36:38 +00:00

Merge pull request 'Rewrite the terse comments in plain English' (#113) from fix/plain-english-comments into refactor/code-hygiene