Skip to content

docs: strip audit/phase citations and change-narration from code comments#264

Merged
zzal merged 1 commit into
mainfrom
chore/comment-sweep
Jul 20, 2026
Merged

docs: strip audit/phase citations and change-narration from code comments#264
zzal merged 1 commit into
mainfrom
chore/comment-sweep

Conversation

@zzal

@zzal zzal commented Jul 20, 2026

Copy link
Copy Markdown
Owner

Audit backlog B12 + the doc half of B13.

Per [comments-are-constraints]: a comment states what the code can't express, not its provenance. This sweeps the reviewer-facing residue the audit flagged:

  • ~65 citations removed(audit V Wave-2 #6), (audit III Wave-2 #9), Phase 15, Phase 13b, etc. — each a self-contained token adding nothing to the constraint beside it. Every substantive sentence is kept.
  • Change-narration trimmedpreviously a missed hand-sync…, the old State<T> class did…, (found via GridBoard playback) — history that belongs in git, not the source. Algorithm descriptions that happen to say "previously-mounted" (i.e. describe the diff, not a change) are untouched.
  • Two actively-misleading headers corrected: ControlClass.swift described a scopedStyles/CSSInjector overlay seam that no SwiflowUI file uses anymore (every control installs via installControlSheet); SwiflowDOM.swift claimed the target "compiles (empty)" on host when it compiles fully (canImport(JavaScriptKit) is unconditionally true) — the dead #else public enum Swiflow {} stub is removed and the always-true guard documented as an intent marker.

54 files, +105/−136. Comment-only except the dead-code #else removal. Whole-package swift test: 1909 green.

🤖 Generated with Claude Code

…ents

Comments now state the constraint the code can't express, never where it
came from or what it replaced (the comments-are-constraints rule). Swept
~65 'audit V Wave-N #N' / 'Phase N' citations and the 'previously/the
old/used to' narration clauses across the runtime, keeping every
substantive constraint. Corrects two actively-misleading headers:
ControlClass.swift described a scopedStyles overlay seam no file uses
anymore (all controls go through installControlSheet), and
SwiflowDOM.swift claimed it 'compiles empty' on host — it compiles fully
(canImport(JavaScriptKit) is always true), so the dead #else stub is
removed and the guard documented as an intent marker.

Comment-only except the dead-code #else removal. Whole-package swift
test: 1909 green.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

📦 Bundle size

Artifact Baseline This PR Δ
App.wasm 5.06 MB 5.23 MB +3.45%
App.wasm (gzip) 1.80 MB 1.87 MB +3.56%
JS runtime 54.5 KB 54.5 KB +0.00%
JS runtime (gzip) 11.3 KB 11.3 KB +0.00%
Total (gzip) 1.81 MB 1.88 MB +3.54%

✅ Within budget (≤5% growth allowed).

Baseline: Swift 6.3, WASM SDK 6.3-RELEASE, measured 2026-06-18.

@zzal
zzal merged commit 9a2e775 into main Jul 20, 2026
6 checks passed
@zzal
zzal deleted the chore/comment-sweep branch July 20, 2026 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant