Repository navigation
docs: tighten webex comments - #37327
Conversation
Shorten wordy comments in commands, renderer, client and two dispatch helpers; keep each constraint and its reason. Comments only; no code change.
UX Review (Opus 5.5) — ⏭️ skippedRevision |
First Principles Review (Opus 5.5) — ✅ PASSPremise-level review of First-Principles-Verdict: PASS Nothing to check. What this change shipsInventory (6 items) — 6 justifiedIntent: help people and agents editing the Webex channel find each rule and its reason in fewer words. This is a FIX to the comments, and the code does not change.
[FIRST-PRINCIPLES-REVIEWED] ac05862 Description read[DESCRIPTION-READ] e734bf5895badf8076d1d4478b93fdceb13d38cd282c88201d52f6138229c9ec That sha256 names the PR description this verdict read. Recompute it with |
Design Review (Opus 5.5) — ✅ PASSDesign-level review of Design-Verdict: PASS Comment-only change. Every added and removed line is a [DESIGN-REVIEWED] ac05862 Description read[DESCRIPTION-READ] 9e868f8b930e55a9a9f1522a0182bdcba0c6a77f22e7ad14c8c0ff2c6bd47bd3 That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
Opus 5.5 Review — ✅ no blocking findingsReviewed Review detailsNo findings. The diff changes only comments in five Notes:
[OPUS-REVIEWED] ac05862 Verdict parsed from the review's SHA-scoped output markers for commit False positive or not applicable? A repository writer can comment: |
GPT 6.1 Review — ✅ no blocking findingsGPT 6.1 completed its review of This comment is updated in place on each push. Review detailsNo findings. False positive or not applicable? A repository writer can comment: |
Code change approver recommendation: A person should decideWhy: the decider raised 1 possible problem and estimates a 50% chance that this change introduces a defect; a person should check it. Comment-only PR in five webex modules; most rewrites keep their facts. But the rewritten redaction-notice comment in renderer.py says the count is over the source the chunks were cut from, as iMessage does. The code counts the shipped chunks ( Things to check (possible problems the decider raised; at this confidence many turn out to be fine):
An automated recommendation, not a review: a maintainer still decides. It approves on its own only when the estimated chance of a defect is at most 12% and the change has at most 400 changed lines. Decider v3c (217fe607) · commit |
KiroCrewCaptain
left a comment
There was a problem hiding this comment.
Verified on this head: every changed line in the five src/kiro_crew/webex/ files is a comment. The parsed AST of each file matches the merge-base, so runtime behaviour cannot change. Docstrings are untouched, so the composition tests that read source through ast and inspect are unaffected. The rewritten commands.py alias comment names two test readers, and both exist: the getattr probe in test_messaging_dispatch.py and the *_ALIASES reflection in test_quick_prompts.py. PR Readiness is green.
Done well: the body states its own proof (AST identity), and that proof reproduces.
Optional:
src/kiro_crew/webex/renderer.py:499: the redaction-notice comment says the count runs over "the whole answer the chunks came from (as iMessage does)". The next line countsdelivered_text, which is the shipped chunks, as the comment at lines 437-438 says. Suggested wording: "Redaction notice, counted over the chunks that shipped, so a placeholder a boundary repair added is counted too." Then drop "(as iMessage does)", because iMessage counts the whole answer. The old text had the same mistake, so this is not a regression.src/kiro_crew/webex/renderer.py:430: the chunking comment no longer says that nothing upstream seals a code fence. That was the reason this split has to be fence-aware. A few words would bring it back.
Problem / Motivation
Goal: Make the
webexcomments short, plain and true, so a reader (person or AI agent) gets each rule and its reason in fewer words.Several comments in
src/kiro_crew/webex/take six to seventeen lines for one or two facts. This PR rewrites those comments. It changes no code.Why it matters
Agents editing the Webex channel read these comments to learn why a budget, a separate message or a named alias set exists. A shorter comment with the same reason is easier to act on and to keep true.
Not a goal
transport_dispatch.pyis skipped (open PR feat(redaction): scrub every persisted conversation row #36640 edits it).What changed (motivation → approach → change)
Comments only, in five files:
commands.py,renderer.py,client.py,transport_dispatch_commands.py,transport_dispatch_origin.py(44 lines added, 60 removed). Each rewrite keeps the same facts and the reason.commands.py_ALIAS_TO_COMMANDrenderer.pyedit budget, chunking, card message, redaction noticeclient.pyscan retry budgettransport_dispatch_commands.pydashboard TTL,transport_dispatch_origin.pydrain nameExamples:
commands.py,_ALIAS_TO_COMMAND(17 lines, hard to follow)Before (second paragraph):
After:
renderer.py, edit budgetBefore:
After:
renderer.py, redaction noticeBefore:
After:
transport_dispatch_commands.py, dashboard TTLBefore:
After:
Backwards compatibility
Compatible: comments only; the AST of every changed file is unchanged.
Removes nothing: no code, test, docstring or check is removed.
Tests
Proof: not provable -- comment-only change; the AST check below shows no code moved.
goal_scan.py astcheckagainst the merge-base: 5 files checked, 0 code-changed, 0 docstring-only.runtime_doc_check.py: 5 files, flagged 0.check_comment_history.pyandcheck_brand_name.pypass on the added lines; flake8 and black are clean; no added line is over 100 columns.Manual verification
N/A — comment-only change.
Related Issues
N/A — part of the src comment cleanup.
Checklist
feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...)Contribution License Agreement
Contributed under the project's Apache-2.0 license.