Repository navigation
Split the Over-Length Comment Sentences in the Agent-Safety Kit, Repo Config, and Snippets - #3615
Conversation
… 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>
|
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.
🟢 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 thetests/test_configure_*.pyandtests/test_secrets_sh.pydocstrings. - Splits the matching comments in the carried snippets (
catalog/snippets/),.coderabbit.yaml,.pr_agent.toml, andpyproject.toml. Adds a trailing period to the Usage lines in theinstall.pymodule docstring. - Leaves code and parsed config values unchanged. The PR states that the Python files are AST-equal to
developwith 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
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>
|
A recorded local strict-review pass covers head |
Codecov Report✅ All modified and coverable lines are covered by tests. 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
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:
|
…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 comment and docstring sentences in the agent-safety kit (
host-setup/agent-safety/claude/),repo-config/configure.sh, thetests/test_configure_*.pyandtests/test_secrets_sh.pydocstrings, the carriedcatalog/snippets/files, and the comments in.coderabbit.yaml,.pr_agent.toml, andpyproject.toml. Every file in the slice reads zero onprose_lint.py --check sentence-length.Comments and docstrings only. Python files are AST-equal to
developwith docstrings blanked, and the parsed YAML and TOML values are equal.catalog/snippets/husky/pre-commitadopts the split already on.husky/pre-commit.Verification
test_install.py(168 tests), thetests/test_configure_*.pysuite,test_secrets_sh.py,test_cli_usage.py,test_build_dist.py,test_repo_gate.py, and the three--selftesthooks pass.bash -n,shellcheck, andshfmt -dare clean onconfigure.sh.opusreview 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.mdcarries 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.ymlandtest-pull-request-smoke.ymlcomments).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:
install.py(about 160, 231, 1196) andtool-containment.py(about 43) leave a short tail on its own line. The previous pass cleared them.install.pyabout 147: "A commandruns_hookalready treats as running the deployed hook carries wrapping characters..." keeps the original's general wording, now in its own sentence.configure.shabout 253: "It does so before every fleet repo is linked to what it names." has a loose second "it".Notes
install.pymodule 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