docs(comments): rewrite comments across all crates to the guidelines

Sweep every first-party crate source (1956 .rs files) to the project comment
guidelines: delete redundant restatements, decorative banners, change
narration, and end-of-line comments; keep and tighten the crucial ones
(invariants, bug rationale, SAFETY blocks, ported-source attribution).

No functional code changed. Every edit is proven comment-only against the
prior tree by a comment-stripping lexer (string/char/raw-string aware) plus a
separate doctest-fence check. Where removing a comment made rustfmt or clippy
want to re-lay-out adjacent code, the minimal triggering comment is restored so
code tokens stay byte-identical.

Gates green: cargo fmt --all --check (0 diffs), cargo check and cargo clippy
--workspace --all-targets (0 warnings).

Adds scripts/check_codegen_comment_guidelines.py — the enforcement gate for
these guidelines (flags banners, end-of-line comments, change narration, and
commented-out code).
This commit is contained in:
ZacharyZhang-NY committed 2026-07-23 16:55:39 -04:00
1 parent ff0fb56c67
commit a02b555e66
1458 files changed
+10729 -21750

No files matched your search

@@ -175,12 +175,9 @@ pub fn compute_layout_with_dispatch(
} else {
1
};
// Standalone peek rect retired. Peek now renders
// INSIDE the dispatch rect (which grows when `peek_visible`,
// computed above). Kept as a zero-height field for ABI compat
// with the existing call sites that still destructure
// `layout.peek`; the field can be removed in a follow-up
// cleanup.
// Peek renders INSIDE the dispatch rect (which grows when
// `peek_visible`, computed above); this field stays zero-height so
// call sites that still destructure `layout.peek` keep compiling.
let peek_h: u16 = 0;
let remaining = area.height.saturating_sub(
top_margin_h
@@ -235,7 +232,7 @@ pub fn compute_layout_with_dispatch(
};
y += header_gap_h;
// Polish — inset the list by LIST_OUTER_HPAD on each side so the
// Inset the list by LIST_OUTER_HPAD on each side so the
// row content and group header rules have side breathing room.
// The outer columns stay painted bg_base by the area-wide fill in
// render_dashboard. Mirrors the dispatch inset pattern but with a
@@ -470,7 +467,7 @@ mod tests {
assert_eq!(layout.list.width, area.width - LIST_OUTER_HPAD * 2);
}
/// Polish — the list rect is inset by LIST_OUTER_HPAD cols on each
/// The list rect is inset by LIST_OUTER_HPAD cols on each
/// side so row content (markers, rules, text) has breathing room
/// and doesn't touch the terminal edges. The outer columns remain
/// bg_base (painted by the top-level area fill).
@@ -674,9 +671,8 @@ mod tests {
assert_eq!(layout.peek.height, 0);
}
/// The standalone peek rect was retired (peek now
/// renders INSIDE the dispatch box). The peek rect is always
/// zero-height; what changes when `peek_visible == true` is
/// Peek renders INSIDE the dispatch box, so the peek rect is
/// always zero-height; what changes when `peek_visible == true` is
/// the dispatch rect, which grows from 3 to 5 rows to host
/// the peek's status + reply input.
#[test]