Skip to content

Split the Over-Length Comment Sentences in the Host Menu, Bootstrap, and Setup Scripts - #3613

Merged
ptr727 merged 9 commits into
developfrom
feature/3531-cmt-host-menu-bootstrap
Oct 29, 2026
Merged

ptr727 merged 9 commits into
developfrom
feature/3531-cmt-host-menu-bootstrap

Conversation

@ptr727

@ptr727 ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner

Part of #3531

Splits the over-length comment and docstring sentences in the host menu, bootstrap, and setup scripts, in their paired .ps1 and .sh forms and the three test files that read them. Only comment lines and Python docstrings change. An AST comparison of the three test files and a changed-line check of the scripts confirm no code or printed string moved.

Verification

  • prose_lint.py --check sentence-length over the 11 files: 261 before, 0 after.
  • bash -n, shfmt -d, and shellcheck clean on the touched .sh files. setup-github.sh keeps its SC2119/SC2120 findings on key_body, which are present at develop too.
  • PowerShell parser: 0 errors on the four touched .ps1 files.
  • tests/test_bootstrap.py (150 tests, 5 skipped) and tests/test_setup_github.py (40 tests): OK.
  • Seven local adversarial review passes at opus. The first six each found meaning drift (mostly a joint reason left attached to only one half), fixed in the commits that follow. The seventh found none, and its pass is recorded against the head.

Known borderline wording left

  • host-setup/windows/upgrade-host.ps1:200-201: "That setting would also corrupt..." can be misread as referring to WSL_UTF8 rather than the console encoding.

Copies left for the comment sweep

  • "Every probe refuses to write a host key" and "A native command writes to this function" also appear in host-setup/bootstrap.ps1 (split here) and in install-agents.ps1, install-tools.ps1, and setup-wsl.ps1 (slice F1).
  • The WSL_UTF8 comment in upgrade-host.ps1 has an unsplit copy near setup-wsl.ps1:121 (slice F1).
  • The "script parameter reached only from a nested scope" and "Under pipefail" sentences have copies in files outside this slice. They were not individually located.

🤖 Generated with Claude Code

ptr727 and others added 8 commits October 29, 2026 08:44
…and Setup Scripts

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>
…ripts

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>
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 16:14
@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 e82923d986754b6a6f18eb49965d2e52e4389466, the content this pull request carries at that commit against develop, and it recorded 0 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

The change still contains an unresolved comment ambiguity that could invert the rationale for the console-encoding conversion.

1 open issue
What changed in this PR

This pull request splits over-length comments and Python docstrings across host menu, bootstrap, setup scripts, and related tests while preserving executable behavior and printed output.

Changes:

  • Reflows long comments and docstrings into shorter sentences and bullet lists.
  • Applies equivalent updates across Bash, PowerShell, and Python files.
  • Improves sentence-length lint compliance without changing runtime logic.

Final review comments note comment-marker consistency in bootstrap.sh and upgrade-host.ps1, an ambiguous encoding reference in upgrade-host.ps1, and wording about the desired registration state in setup-github.sh.

File Description
tests/​test_setup_github.py Splits the test module docstring.
tests/​test_bootstrap.py Splits bootstrap test docstrings and explanatory comments.
tests/​host_capability.py Splits host capability docstrings.
host-setup/​windows/​upgrade-host.ps1 Splits Windows upgrade comments. Final comments: [P2] encoding reference ambiguity (severity: nit, 4 votes) and [P2] prescribed comment-marker usage (severity: nit, 1 vote).
host-setup/​windows/​setup-github.ps1 Splits Windows GitHub setup comments.
host-setup/​menu.sh Splits Bash menu and locking comments.
host-setup/​menu.ps1 Splits PowerShell menu and locking comments.
host-setup/​linux/​upgrade-host.sh Splits Linux upgrade comments.
host-setup/​linux/​setup-github.sh Splits Linux GitHub setup comments. Final comment: [P1] desired registration-state wording (severity: nit, 1 vote).
host-setup/​bootstrap.sh Splits Bash bootstrap comments. Final comment: [P2] prescribed comment-marker usage (severity: nit, 1 vote).
host-setup/​bootstrap.ps1 Splits PowerShell bootstrap comments.

Review effort: Lite

Comment thread host-setup/windows/upgrade-host.ps1 Outdated
Part of #3531

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@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 (b38e084) to head (21ec5a0).
⚠️ Report is 7 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3613   +/-   ##
========================================
  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

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head 21ec5a0cbdcdb2ae89018603bc303e376874c228, the content this pull request carries at that commit against develop, and it recorded 0 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.

🟢 Approval recommended

The pull request is limited to documentation formatting with no executable behavior changes, and no active review issues remain.

No open issues 🎉

1 resolved since last review

Review effort: Lite

@ptr727
ptr727 merged commit 0b91957 into develop Oct 29, 2026
14 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-host-menu-bootstrap branch October 29, 2026 18:58
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