Skip to content

Split the Over-Length Comment Sentences in the Host Install Scripts - #3612

Merged
ptr727 merged 8 commits into
developfrom
feature/3531-cmt-host-install
Oct 29, 2026
Merged

ptr727 merged 8 commits into
developfrom
feature/3531-cmt-host-install

Conversation

@ptr727

@ptr727 ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner

Part of #3531

Splits the over-length comment sentences in the host install scripts (install-tools, install-agents, install-skills, setup-wsl) and two test docstrings. Only comment lines and the two test module docstrings change. The .sh and .ps1 parallel comments are split identically, and where a Markdown copy already read zero its wording was adopted. prose_lint --check sentence-length reads 208 before and 0 after on the nine files.

Verification: bash -n, shellcheck, shfmt -d clean on each .sh. Each .ps1 parses with zero errors and PSScriptAnalyzer (repo settings) reports 0. test_install_tools, test_install_agents, test_host_gate, test_cli_usage, test_skills_install, test_bootstrap, test_setup_github pass.

Copies left for the comment sweep

None found outside the slice. The sentences with Markdown copies (host-setup/windows/README.md, docs/host-setup.md) already read zero and were adopted.

🤖 Generated with Claude Code

ptr727 and others added 5 commits October 29, 2026 08:28
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>
…gged

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 15:49
@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 d0322631f79b1605264c134edd4e30c696a8ae00, 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

A remaining contract-bullet wording defect makes the intended null behavior unclear and should be corrected.

1 open issue
What changed in this PR

This pull request splits over-length comments and two test-module docstrings in the host installation scripts while preserving executable behavior.

Changes:

  • Split long comments in the Linux and Windows tool, agent, skills, and WSL installers.
  • Reworked test docstrings and a Windows test comment into shorter sentences and lists.
  • Kept parallel Linux and PowerShell wording aligned.
File Description
tests/​test_install_tools.py Splits the installer JSON-report test docstring.
tests/​test_install_agents.py Splits the agent-installer test docstring and Windows harness comment.
host-setup/​windows/​setup-wsl.ps1 Splits WSL and Docker integration comments.
host-setup/​windows/​install-tools.ps1 Splits Windows tool-installer comments.
host-setup/​windows/​install-skills.ps1 Splits skills-installer comments.
host-setup/​windows/​install-agents.ps1 Splits Windows agent-updater comments.
host-setup/​linux/​install-tools.sh Splits Linux tool-installer comments.
host-setup/​linux/​install-skills.sh Splits Linux skills-installer comments.
host-setup/​linux/​install-agents.sh Splits Linux agent-updater comments.

Review effort: Lite

Comment thread tests/test_install_tools.py 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 (2088775).
⚠️ Report is 6 commits behind head on develop.

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

🔵 Needs a closer look

The change still has active review issues: grammar errors in the version-resolution explanation and brittle comments that hard-code a condition count, each repeated in another location.

No open issues 🎉

2 previously missed issues

In code that hasn't changed since last review

Low severity Fix grammar in version-resolution explanation

host-setup/​windows/​install-tools.ps1:311

[P2] Fix the grammar in the version-resolution explanation and there no single version compares is not a grammatical clause, and the next sentence uses singular is with the plural subject Two products. Rewrite these lines so the multiple-version case remains clear.

This issue also appears on line 412 of the same file.

Low severity Remove the incidental condition count

host-setup/​windows/​install-tools.ps1:891

[P2] Remove the incidental condition count The comment style contract requires an enumeration to refer to its items rather than duplicate their size. Four conditions will become stale if this safety predicate changes, so describe the conditions without counting them.

This issue also appears on line 924 of the same file.

1 resolved since last review

Review effort: Lite

ptr727 and others added 2 commits October 29, 2026 09:08
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 20887759a79105e0cceb3dde4b6d7e9d8350f6c4, the content this pull request carries at that commit against develop, and it recorded 2 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

No unresolved review issues remain, and the changes are limited to comment and docstring formatting without altering runtime behavior.

No open issues 🎉

Review effort: Lite

@ptr727

ptr727 commented Oct 29, 2026

Copy link
Copy Markdown
Owner Author

Answering the two previously missed items from the e2256ee round, both fixed on 2088775. "Fix grammar in version-resolution explanation": the clause now reads "no single version compares there" and the next sentence reads "Two products sharing an id are what ...", and the "Two ids share a version" sentence in the sibling block is fixed too. "Remove the incidental condition count": the "Four conditions" lead-in now reads "All the conditions below are required together, for these reasons:".

@ptr727
ptr727 merged commit aa86ac1 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-install 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