Skip to content

Split the Over-Length Comment Sentences in build_dist, carry, handoff, and skills_install - #3608

Merged
ptr727 merged 6 commits into
developfrom
feature/3531-cmt-dist-carry-handoff
Oct 29, 2026
Merged

ptr727 merged 6 commits into
developfrom
feature/3531-cmt-dist-carry-handoff

Conversation

@ptr727

@ptr727 ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner

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, and tests/test_carry.py. prose_lint --check sentence-length goes 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 --check reports the generated trees current, and the carry, handoff, build_dist, and skills_install tests pass.

Notes:

  • The module docstrings of build_dist.py and skills_install.py feed argparse description, so their --help wording changes. No test asserts on it.
  • The Usage synopsis in the handoff.py module docstring gains - bullet prefixes, since the gate reads an unterminated synopsis block as one long sentence. Only the docstring's first line reaches --help.
  • Where scripts/README.md already read zero, its wording was adopted (the --repo no-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_destinations docstring, a two-part reason in tree_source now read as two, and "it" two sentences from str.splitlines in carry.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, and AGENTS.md. Those carry different wordings of the same content, not identical sentences, so no pair is left for another slice.

🤖 Generated with Claude Code

ptr727 and others added 4 commits October 29, 2026 07:36
…, 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>
@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:52
@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
@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 4b507c6e8e19e807de4bed644af7fdf7f6f08968, the content this pull request carries at that commit against develop, and it recorded 3 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

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.py Usage synopsis gains bullet prefixes so the check reads it as a list rather than one long sentence.
  • The module docstrings of build_dist.py and skills_install.py feed 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

Comment thread scripts/build_dist.py Resolved
Comment thread scripts/carry.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 (4f70527).
⚠️ Report is 2 commits behind head on develop.

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           
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.

ptr727 and others added 2 commits October 29, 2026 08:00
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>
@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

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

@ptr727
ptr727 merged commit 6cbe298 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-dist-carry-handoff 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