chore: brutal comment audit — obliterate restatement, narration, decoration - #675
Merged
Conversation
…ration Apply the comment-audit bar across the whole first-party tree, doc comments included. Cut signature-restating docstrings (public or not), step-label narration, snapshot rot, duplicated rationale, and all // MARK: decoration. Keep only what the code can't say: external/wire-protocol facts, non-obvious whys (LWW/upsert/token semantics), framework gotchas (SwiftData history, @unchecked Sendable soundness, SQL-null predicates), and justifications for suspicious-looking code. Behavior-neutral: comment-only. SwiftSync 190, DemoCore 44, DemoBackend 32, demo build + DemoUITests 3/3 all green.
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
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.
Ran the comment-audit bar at full aggression across the whole first-party tree — doc comments included — and stripped everything the code already says.
Net: −336 comment lines (479 deleted / 143 kept-or-reflowed, 47 files).
What died
///), public or not —@SyncQuery/@SyncModel/publisher-family navigation docs,init/getter docs that re-say the name.// insert,// Reconnect:,// Act/// given-when-then, assertion restatement (the test names + messages carry it).// MARK:(22 of them).What survived (the narrow bar)
Only what the code genuinely can't express, trimmed to the load-bearing clause:
absent vs nullsemantics);.preserveValueOnDeletion,@unchecked Sendablesoundness,nil != "inbound"is SQL NULL);Verification
Behavior-neutral (comment-only + reflow). SwiftSync 190, DemoCore 44, DemoBackend 32, demo app builds, DemoUITests 3/3 — all green.