Repository navigation
Split the Over-Length Comment Sentences in build_dist, carry, handoff, and skills_install - #3608
Conversation
…, and skills_install Part of #3531. Comments and docstrings only, meaning unchanged. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Part of #3531. 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
Two unresolved nit-level findings remain, both involving ambiguous references after a sentence split: "it" at scripts/carry.py line 435 and "Outside one" at scripts/build_dist.py line 277.
2 open issues
What changed in this PR
This PR splits over-length sentences in comments and docstrings across the build, handoff, carry, and skills installer scripts and their tests. It is part of #3531, which asks for the repository's sentence-length check to pass on these files. The check drops from 214 hits to 0. The change is limited to comments and docstrings, so program behavior is unchanged.
Changes:
- Long comment and docstring sentences are split into shorter sentences in the listed scripts and tests.
- The
handoff.pyUsage synopsis gains bullet prefixes so the check reads it as a list rather than one long sentence. - The module docstrings of
build_dist.pyandskills_install.pyfeed argparse--help, so their help wording changes. No test checks that text.
| File | Description |
|---|---|
| tests/test_skills_install.py | Splits long docstring and comment sentences in the installer tests. Wording only. |
| tests/test_handoff.py | Splits long docstring sentences in the handoff tests. Wording only. |
| tests/test_carry.py | Splits long docstring sentences in the carry tests. Wording only. |
| tests/test_build_dist.py | Splits long docstring and comment sentences in the build tests. Wording only. |
| scripts/skills_install.py | Splits long module, function, and comment sentences. The module docstring feeds --help. |
| scripts/skills_install.ps1 | Splits one long launcher comment into shorter lines. |
| scripts/handoff.py | Splits long docstring and comment sentences and bullets the Usage synopsis. |
| scripts/carry.py | Splits long comment and docstring sentences, including the line-ending and section-reconciliation notes. |
| scripts/build_dist.py | Splits long comment and docstring sentences. The module docstring feeds --help. |
Review effort: Lite
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #3608 +/- ##
========================================
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 comments and docstrings of
scripts/build_dist.py,scripts/handoff.py,scripts/carry.py,scripts/skills_install.py,scripts/skills_install.ps1,tests/test_build_dist.py,tests/test_handoff.py,tests/test_skills_install.py, andtests/test_carry.py.prose_lint --check sentence-lengthgoes from 214 hits to 0 across them.Comments and docstrings only. Python ASTs with docstrings masked are identical to base,
python3 scripts/build_dist.py --checkreports the generated trees current, and the carry, handoff, build_dist, and skills_install tests pass.Notes:
build_dist.pyandskills_install.pyfeed argparsedescription, so their--helpwording changes. No test asserts on it.handoff.pymodule docstring gains-bullet prefixes, since the gate reads an unterminated synopsis block as one long sentence. Only the docstring's first line reaches--help.scripts/README.mdalready read zero, its wording was adopted (the--repono-default sentence, the include-region sentence, and the carry tree-root sentences).Local review: four recorded passes, the last over the current head with no meaning drift. Remaining borderline items, all left as is: an elliptical "So is one" in the
include_destinationsdocstring, a two-part reason intree_sourcenow read as two, and "it" two sentences fromstr.splitlinesincarry.py.Copies left for the comment sweep
A search of the whole tree (every tracked file outside this slice) for the replaced sentences found matches only in files that already read zero:
scripts/README.md, the skills under.agents/skills/,.github/skills/,.claude-plugin/,.github/copilot-instructions.md, andAGENTS.md. Those carry different wordings of the same content, not identical sentences, so no pair is left for another slice.🤖 Generated with Claude Code