Skip to content

Split the Over-Length Comment Sentences in the Prose and Repo Gates - #3609

Merged
ptr727 merged 5 commits into
developfrom
feature/3531-cmt-gates
Oct 29, 2026
Merged

ptr727 merged 5 commits into
developfrom
feature/3531-cmt-gates

Conversation

@ptr727

@ptr727 ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner

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-length check reads zero on all 11 files, down from 181 hits. An AST comparison (docstrings blanked) of every changed .py file shows no code change, and the Husky and action.yml changes are # comment lines only.

Tests: test_prose_lint (629), test_repo_gate (176), test_tooling_encoding (4), test_pre_commit_hook (3), and test_python_directories (32) pass. No hit sat in a fixture string, so no test data changed.

Copies left for the comment sweep

  • .husky/pre-commit line 28 ("Running one rather than testing for a name is the point...") is copied verbatim at catalog/snippets/husky/pre-commit line 32, outside this slice. The pair is now unaligned.
  • scripts/README.md already read zero. Its wording was adopted for the sha-pin docstring in repo_gate.py and the trailing-comment docstring in test_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.
  • Formatting: .github/actions/repo-gate/repo_gate.py check_sha_pin docstring has a short line before "A fabricated pin..." that was not rewrapped.
  • Formatting: the rewrap breaks an inline code span across a line in five places in tests/test_prose_lint.py.

🤖 Generated with Claude Code

ptr727 and others added 3 commits October 29, 2026 07:38
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>
@ptr727 ptr727 added the comments Permits the comment lines the pull request adds or edits, which the prose gate otherwise refuses label Oct 29, 2026
Copilot AI lite review requested due to automatic review settings October 29, 2026 14:54
@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head adaa6ed009f7a989dc7db5ebbd8a8590456fe276, the content this pull request carries at that commit against develop, and it recorded 4 findings.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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

Comment thread .github/actions/repo-gate/repo_gate.py Resolved
Comment thread tests/test_prose_lint.py Resolved
Comment thread tests/test_prose_lint.py Resolved
Comment thread tests/test_prose_lint.py Resolved
@codecov

codecov Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.60%. Comparing base (0d4e6f1) to head (c80d711).
⚠️ Report is 3 commits behind head on develop.

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           
Flag Coverage Δ
python-3.13 81.60% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Part of #3531.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head eb5641189fb8808977230fb0954749bc5a64a5a7, the content this pull request carries at that commit against develop, and it recorded 8 findings.

Part of #3531.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head c80d7112d86acdfbd92d00151f368c1b557a0671, the content this pull request carries at that commit against develop, and it recorded 0 findings.

@ptr727
ptr727 merged commit 3428666 into develop Oct 29, 2026
13 checks passed
ptr727 added a commit that referenced this pull request Oct 29, 2026
…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)
@ptr727
ptr727 deleted the feature/3531-cmt-gates branch October 29, 2026 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comments Permits the comment lines the pull request adds or edits, which the prose gate otherwise refuses

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants