chore: condense Claude comments - #1158
Conversation
|
Claude finished @mbevc1's task in 2m 23s —— View job Review — PR #1158
Static analysis
Docs-only change ( Resolved since the last run
Still open1. Example label no longer matches the rule it illustrates — Rule 2 now explicitly allows a counterfactual when it is the reason, and the Good version on lines 54-56 keeps the same "without this" framing. So "history and justification" mislabels what's actually wrong: three lines of narration around one load-bearing fact — i.e. the 2. GitHub autolinks bare 3. Mixed comment markers (nit) — four examples use Deliberate now that line 59 demonstrates the Go godoc exception, but a half-sentence saying markers are illustrative would remove the ambiguity. Non-blocking. 4. Discoverability (nit) — the skill isn't referenced from
What's goodThe rules are ordered and each is falsifiable, which is what makes this usable by an agent rather than aspirational. The paired Bad/Good examples showing the same fact at two lengths teach compression rather than just prohibition — more useful than a list of bans. The Verdict: approve-with-nits. Only item 1 is a real correctness problem in the doc; the rest are polish. |
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
| Bad — history and justification burying one fact: | ||
| `# Without this the analytics preflight only ran from the client-triggered background` | ||
| `# check, so an operator who navigated away before the initiate response landed got a` | ||
| `# plan with no analytics check recorded...` |
There was a problem hiding this comment.
The label no longer matches the rule it illustrates. Rule 2 now explicitly allows a counterfactual when it is the reason, so "history and justification" mislabels what's wrong here — the Good version two lines down keeps the same counterfactual. What this example actually demonstrates is the Precise means rule: three lines of narration around one load-bearing fact.
| Bad — history and justification burying one fact: | |
| `# Without this the analytics preflight only ran from the client-triggered background` | |
| `# check, so an operator who navigated away before the initiate response landed got a` | |
| `# plan with no analytics check recorded...` | |
| Bad — one fact buried in three lines of narration: | |
| `# Without this the analytics preflight only ran from the client-triggered background` | |
| `# check, so an operator who navigated away before the initiate response landed got a` | |
| `# plan with no analytics check recorded...` |
| Good — same fact, stated precisely (ref kept as a pointer): | ||
| `# Record the analytics preflight here too — the post-initiate auto-run misses it` | ||
| `# when the client navigates away before the initiate response lands (#5765).` |
There was a problem hiding this comment.
Two low-priority points about the examples as a set:
#5765renders as a live link to the wrong thing. GitHub autolinks bare#Nrefs, so in this repo#5765(also on line 42) points at kosli-dev/cli#5765, which doesn't exist — the repo is around chore: condense Claude comments #1158. An agent copying the pattern would learn to invent refs. A placeholder avoids that:(#NNNN)or(kosli-dev/cli#1158).- Mixed comment markers. Four examples use
#, the last uses//. The skill is language-agnostic by design, so this may be deliberate — but every comment it will actually be applied to in this repo is//, and the godoc carve-out on lines 17-18 is Go-specific. Either convert them all to//, or note explicitly that markers are illustrative.
Neither blocks merge.
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Add comment style skill and try to prevent proliferating code comments.
Checklist
charts/k8s-reporter/) updated, if needed. Note: these changes live in a separate PR