Repository navigation
Split the Over-Length Comment Sentences in the Prose and Repo Gates - #3609
Conversation
Part of #3531. Comment, docstring, and hook-comment text only. No runtime behavior changes. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531. Restores reasons and antecedents the first splits loosened, and rewraps the touched paragraphs. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
|
A recorded local strict-review pass covers head |
There was a problem hiding this comment.
🟡 Changes recommended
Several active prose-formatting and clarity issues remain in the affected docstrings, including broken line wraps, an unclear antecedent, and an incomplete rationale.
4 open issues
What changed in this PR
This pull request reformats over-length comments and docstrings across repository gates, actions, Husky hooks, and their tests. The changes preserve executable behavior and test data.
Changes:
- Splits long Python comments and docstrings into shorter sentences.
- Reflows Husky, composite-action, and workflow comments.
- Updates explanatory test documentation without changing test logic.
| File | Description |
|---|---|
tests/test_tooling_encoding.py |
Reflows encoding-test documentation and comments. |
tests/test_repo_gate.py |
Reflows repository-gate test documentation. |
tests/test_prose_lint.py |
Reworks prose-lint test documentation and comments. |
tests/test_pre_commit_hook.py |
Reflows pre-commit integration-test documentation. |
scripts/prose_lint.py |
Reflows the local prose-runner docstring. |
.husky/pre-push |
Splits interpreter and version-check comments. |
.husky/pre-commit |
Splits interpreter-selection comments. |
.github/actions/repo-gate/repo_gate.py |
Reflows repository-gate documentation and docstrings. |
.github/actions/python-directories/python_directories.py |
Reflows Python-directory resolver documentation. |
.github/actions/prose-gate/prose_lint.py |
Reflows prose-action documentation and docstrings. |
.github/actions/prose-gate/action.yml |
Reflows composite-action comments. |
Review effort: Lite
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #3609 +/- ##
========================================
Coverage 81.60% 81.60%
========================================
Files 26 26
Lines 9070 9070
========================================
Hits 7402 7402
Misses 1668 1668
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Part of #3531. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
|
A recorded local strict-review pass covers head |
Part of #3531. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
|
A recorded local strict-review pass covers head |
…tence-length a Default Check (#3619) Promotes the #3531 comment sweep and its default flip from `develop` to `main`. - [#3603](#3603) Moves the dispatch-refresh note out of the Docker clause in branching-and-release-model. - [#3606](#3606) Splits over-length comment sentences in pr_review and host_gate. - [#3607](#3607) Splits over-length comment sentences in the local and canonical review engines. - [#3608](#3608) Splits over-length comment sentences in build_dist, carry, handoff, and skills_install. - [#3609](#3609) Splits over-length comment sentences in the prose and repo gates. - [#3611](#3611) Splits over-length comment sentences in the spec scripts and workflows. - [#3612](#3612) Splits over-length comment sentences in the host install scripts. - [#3613](#3613) Splits over-length comment sentences in the host menu, bootstrap, and setup scripts. - [#3615](#3615) Splits over-length comment sentences in the agent-safety kit, repo config, and snippets. - [#3618](#3618) Makes `sentence-length` a default prose gate check. Closes #3531 Closes #3588 🤖 Generated with [Claude Code](https://claude.com/claude-code)

Part of #3531
Splits the over-length sentences in the comments, docstrings, and hook comments of the prose gate, the repo gate, the python-directories action, the two Husky hooks, and their tests. Comment and docstring text only. The
sentence-lengthcheck reads zero on all 11 files, down from 181 hits. An AST comparison (docstrings blanked) of every changed.pyfile shows no code change, and the Husky andaction.ymlchanges are#comment lines only.Tests:
test_prose_lint(629),test_repo_gate(176),test_tooling_encoding(4),test_pre_commit_hook(3), andtest_python_directories(32) pass. No hit sat in a fixture string, so no test data changed.Copies left for the comment sweep
.husky/pre-commitline 28 ("Running one rather than testing for a name is the point...") is copied verbatim atcatalog/snippets/husky/pre-commitline 32, outside this slice. The pair is now unaligned.scripts/README.mdalready read zero. Its wording was adopted for thesha-pindocstring inrepo_gate.pyand the trailing-comment docstring intest_prose_lint.py.Local review findings left open
Three recorded passes ran. The edit budget is spent, so these remain, each for the review loop:
tests/test_prose_lint.py, the "default is pinned too" docstring: "every such promotion" now precedes its antecedent, and the two reasons became a chain.tests/test_prose_lint.py, the "pinned because only one side moved" docstring: "The reason is that" covers only the first half of what the original colon introduced..github/actions/repo-gate/repo_gate.pycheck_sha_pindocstring has a short line before "A fabricated pin..." that was not rewrapped.tests/test_prose_lint.py.🤖 Generated with Claude Code