R17 (#103): comment cleanup — delete restatement, keep rationale - #124
Merged
Conversation
Judgement per site (no bulk delete, no behaviour change). Deleted 14 comments
that only restated a self-explanatory identifier: EmptyBlock, LiveDot, yearOf,
sceneToSvg, download, startWire, armShape, ShapeGlyph, shortDate, setStatus,
pointsAttr (frontend) and MapOpsType, MapOpsStatus, OpsImpactRowDto (backend).
Trimmed 3 to just their non-obvious contract: monthOfIso (0..11/null),
translateNode (freehand points move too), initialsOf (the algorithm).
Kept the ones the heuristic mis-flagged — they carry real information, not
restatement: MapAdoPriority ("1 highest…4 lowest"), MapSprintState/MapPriority
(input/output vocab), LastSegment/DatePart (format + empty-string contract with
a worked example), MonthOf, ObjNameArray, EpicKeyOf (fallback algorithm), and the
two Whiteboards MapDelete comments (there "MapDelete" is the HTTP-verb helper —
the comment documents the cascade, not the identifier).
api.ts:100-102 (the stale example) was already removed in R11. No comment found
contradicting its code in this pass (the R2-style Jira gate case is already
fixed). Added the why-not-what rule to CLAUDE.md §9.
Frontend build + 145 tests green; backend build + 507 tests green.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01F1g44VLAeYdf3FAoXsXRu7
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Part of the code-review remediation epic (#106). Addresses R17 / #103. A comment that restates the line below is a defect — two statements of one fact, nothing keeping them in sync — and here it once concealed a real authorization bug (the R2 case). Judgement per site, no bulk delete, no behaviour change.
Group (a) — worked site by site
Deleted (14 pure restatements):
EmptyBlock,LiveDot,yearOf,sceneToSvg,download,startWire,armShape,ShapeGlyph,shortDate,setStatus,pointsAttr(frontend);MapOpsType,MapOpsStatus,OpsImpactRowDto(backend).Trimmed to their non-obvious contract (3):
monthOfIso(→ "0..11; null if empty/invalid"),translateNode(→ "freehand nodes also shift their polyline points"),initialsOf(→ the algorithm).Kept — the heuristic mis-flagged these (they carry real information, not restatement):
MapAdoPriority("1 highest…4 lowest"),MapSprintState/MapPriority(input/output vocabulary),LastSegment/DatePart(format + empty-string contract with a worked example),MonthOf,ObjNameArray,EpicKeyOf(fallback algorithm), and the twoMapDeleteendpoint comments inWhiteboards.cs— thereMapDeleteis the ASP.NET HTTP-verb helper, so the comment documents the cascade delete, not an identifier. Each keep is a deliberate group-(c) call.Not touched / notes
--- SECTION ---banners and group (c) false-positives: left alone per the issue.src/api.ts:100-102(stale commented example): already removed in R11.Jira.csgate comment is already fixed.CLAUDE.md §9(Do), phrased for humans and assistants, including "treat a comment that contradicts its code as a suspected bug".Acceptance
No renames were needed (the deleted-comment identifiers are self-explanatory), so there are no call-site changes.
🤖 Generated with Claude Code
Generated by Claude Code