Repository navigation
Split the Over-Length Comment Sentences in pr_review and host_gate - #3606
Conversation
|
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
Two active nit-level findings remain open: an unclear remedy clause in the probe() docstring in scripts/host_gate.py, and missing blank lines before separate rules in the help text in scripts/pr_review.py.
2 open issues
What changed in this PR
This PR splits over-length sentences in the comments and docstrings of the PR review scripts, the cleanup script, the GraphQL helper, and the host gate, along with two of their test files. It is part of a wider effort to bring the repository's sentence-length check to zero. It changes no code and no asserted string, so behavior stays the same. The author reports that the sentence-length count for this slice went from 186 to 0.
Changes:
- Long sentences in comments and docstrings are split into shorter ones.
- Some run-on lists of conditions and exit codes become bullet points.
- The
pr_cleanup.pybranch-finished sentence is reworded to match the wording inscripts/README.md.
| File | Description |
|---|---|
| tests/test_pr_review.py | Rewraps long test docstrings and comments into shorter sentences. Assertions are unchanged. |
| tests/test_host_gate.py | Splits long docstring and comment sentences. Two schema-comparison comments are reworded. |
| scripts/pr_review.py | Splits the help text into shorter sentences and turns skip and exit-code conditions into bullets. Pinned docstring phrases are unchanged. |
| scripts/pr_review_rounds.py | Splits docstrings for the table matcher, thread matcher, and local-pass check. The local-pass check now lists its conditions. |
| scripts/pr_review_copilot.py | Splits one module docstring sentence and one entry-parsing docstring sentence. |
| scripts/pr_review_checks.py | Splits long sentences in the check normalization docstring. |
| scripts/pr_cleanup.py | Turns the refusal conditions into a list and splits the sweep's finished-branch definition. |
| scripts/host_gate.py | Splits long module, probe, merge, and overlay docstrings and comments. Some lists become bullets. |
| scripts/gh_graphql.py | Splits the module docstring and the request and walker docstrings into shorter sentences. |
Review effort: Lite
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #3606 +/- ##
========================================
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:
|
|
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 and docstrings of
pr_review*.py,pr_cleanup.py,gh_graphql.py,host_gate.py, and their two test files. Comments and docstrings only, no code or asserted string changed.scripts/pr_review.py's pinned docstring phrases are unchanged.Sentence-length count for the slice went from 186 to 0.
Tests:
uv run --no-project --with pytest --with markdown-it-py python -m pytest tests/test_pr_review.py tests/test_host_gate.py tests/test_pr_review_size.py tests/test_pr_cleanup.py tests/test_gh_graphql.pypasses (696 passed).The
pr_cleanup.py"A branch is finished when" sentence uses the wordingscripts/README.mdalready carries.Copies left for the comment sweep
None. The two
scripts/README.mdtable cells that restate pieces of thestatusandwaitexit codes are worded differently and already read zero.Local strict review: two passes, the first raised drift items that the last commit restores, the second found none.
🤖 Generated with Claude Code