Comment review
Review only the requested files or current diff.
- Classify each comment as narration, stale explanation, workaround, invariant, platform constraint, security boundary, data migration note, authored-asset contract, or public API documentation.
- Delete narration that repeats the code. Improve names, types, data shapes, or module boundaries when a comment exists only because the code is hard to follow.
- Keep a concise comment when it explains a non-obvious reason the code cannot express, including Roblox engine behavior, ordering, replication, persistence, security, or authoring constraints.
- Verify claims against source, repository guidance, and current Roblox behavior when the claim may have changed. Use
$howor$whyfor uncertain constraints. - Treat analyzer suppressions and casts as evidence. Remove them only after the root cause is fixed and the relevant check passes.
- Report deleted, rewritten, and retained comments with the reason for every retained exception.
Never trade a useful invariant for silence. The target is less reader work, not zero comments.