Skip to content

Split the Over-Length Comment Sentences in the Agent-Safety Kit, Repo Config, and Snippets - #3615

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

ptr727 merged 8 commits into
developfrom
feature/3531-cmt-safety-config

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 agent-safety kit (host-setup/agent-safety/claude/), repo-config/configure.sh, the tests/test_configure_*.py and tests/test_secrets_sh.py docstrings, the carried catalog/snippets/ files, and the comments in .coderabbit.yaml, .pr_agent.toml, and pyproject.toml. Every file in the slice reads zero on prose_lint.py --check sentence-length.

Comments and docstrings only. Python files are AST-equal to develop with docstrings blanked, and the parsed YAML and TOML values are equal. catalog/snippets/husky/pre-commit adopts the split already on .husky/pre-commit.

Verification

  • test_install.py (168 tests), the tests/test_configure_*.py suite, test_secrets_sh.py, test_cli_usage.py, test_build_dist.py, test_repo_gate.py, and the three --selftest hooks pass. bash -n, shellcheck, and shfmt -d are clean on configure.sh.
  • Six adversarial opus review passes, each fixing what the previous found. The last pass found nothing and is recorded and attested on the head.

Copies left for the comment sweep

None. docs/reusable-workflows.md carries two snippet sentences verbatim and a test holds them byte-for-byte equal to the catalog snippets, so that file is changed here to match (merge-bot-pull-request.yml and test-pull-request-smoke.yml comments).

Remaining review findings from the last local pass

The final recorded pass (seventh) raised six items, all cosmetic or arguable, left unedited after the edit budget:

  • Four wrapped docstring lines in install.py (about 160, 231, 1196) and tool-containment.py (about 43) leave a short tail on its own line. The previous pass cleared them.
  • install.py about 147: "A command runs_hook already treats as running the deployed hook carries wrapping characters..." keeps the original's general wording, now in its own sentence.
  • configure.sh about 253: "It does so before every fleet repo is linked to what it names." has a loose second "it".

Notes

  • The Usage lines in the install.py module docstring gained a trailing period each, so the sentence gate reads them as separate sentences. __doc__ is not used for --help.

🤖 Generated with Claude Code

ptr727 and others added 6 commits October 29, 2026 09:28
… Config, and Snippets

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>
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:42
@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 ea1def4aa678229ab5129c11e4aa9938b7afa91a, 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 review evidence records no active issues, and the described changes only split comments and docstrings without altering code or parsed config values.

No open issues 🎉

What changed in this PR

This PR splits over-length comment and docstring sentences so that every file in its slice passes the prose_lint.py --check sentence-length gate. The slice covers the agent-safety kit, the repo-config script, the configure test docstrings, the carried catalog snippets, and the tool config comments. Each change rewraps comments or docstrings without changing code behavior. It is part of the wider effort tracked in #3531 to bring prose under the sentence-length rule.

Changes:

  • Splits long comment and docstring sentences into shorter sentences in the agent-safety kit (host-setup/agent-safety/claude/), repo-config/configure.sh, and the tests/test_configure_*.py and tests/test_secrets_sh.py docstrings.
  • Splits the matching comments in the carried snippets (catalog/snippets/), .coderabbit.yaml, .pr_agent.toml, and pyproject.toml. Adds a trailing period to the Usage lines in the install.py module docstring.
  • Leaves code and parsed config values unchanged. The PR states that the Python files are AST-equal to develop with docstrings blanked, and that the YAML and TOML values are equal.
File Description
tests/​test_secrets_sh.py Splits long docstring and setUp comment sentences.
tests/​test_configure_usage.py Splits the module docstring sentences.
tests/​test_configure_settings_live.py Splits the module docstring sentences.
tests/​test_configure_ruleset_id.py Splits the module and helper docstring sentences.
tests/​test_configure_project.py Splits the module, helper, and case docstring sentences.
tests/​test_configure_model.py Splits the module docstring sentences.
tests/​test_configure_envname.py Splits the module docstring sentences.
tests/​test_configure_environments.py Splits the module, helper, and case docstring sentences.
tests/​test_configure_archived.py Splits the module and helper docstring sentences.
repo-config/​configure.sh Splits long header, lookup, and check-function comments. Text only, with no logic change.
pyproject.toml Splits the mypy and pyright platform-pin comments.
host-setup/​agent-safety/​claude/​tool-containment.py Splits the module docstring and function docstrings.
host-setup/​agent-safety/​claude/​test_install.py Splits docstrings and comments in the install test suite.
host-setup/​agent-safety/​claude/​stray-process-sweep.py Splits the module docstring and the sweep helper comments.
host-setup/​agent-safety/​claude/​install.sh Splits the Python interpreter selection comment.
host-setup/​agent-safety/​claude/​install.py Splits the module docstring, usage lines, and helper docstrings.
host-setup/​agent-safety/​claude/​install.ps1 Splits the Python 3 verification comment.
host-setup/​agent-safety/​claude/​gh-write-guard.py Splits the module docstring, the denied-shape list, and helper docstrings.
catalog/​snippets/​workflows/​test-pull-request.yml Splits the trigger-shape comment.
catalog/​snippets/​workflows/​test-pull-request-smoke.yml Splits the Docker secrets mapping comment.
catalog/​snippets/​workflows/​merge-bot-pull-request.yml Splits the rules-block comment.
catalog/​snippets/​husky/​pre-commit Splits the interpreter selection comment to match .husky/pre-commit.
catalog/​snippets/​hub_fetch_run.py Splits the module docstring and the unborn-HEAD helper docstrings.
.pr_agent.toml Splits the review-guideline comments. Parsed values are unchanged.
.coderabbit.yaml Splits the review-config comments. Parsed values are unchanged.

Review effort: Lite

ptr727 and others added 2 commits October 29, 2026 09:57
A test holds the smoke caller stub in the doc byte-for-byte equal to its catalog snippet.

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 dec449114ceebd45b7acf0b77fa61b9afad2fd23, the content this pull request carries at that commit against develop, and it recorded 6 findings.

@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 (dec4491).
⚠️ Report is 9 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3615   +/-   ##
========================================
  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 merged commit eccf9f6 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-safety-config 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