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

@@ -138,10 +138,9 @@ mod tests {
fn test_partial_block() {
let area = Rect::new(0, 0, 10, 1);
let mut buf = Buffer::empty(area);
// 25% of 4 cells = 1 full block (8 eighths). Actually 0.25*4*8 = 8 = 1 full.
// Let's use 12.5% of 4 cells = 0.125*4*8 = 4 eighths = half block on cell 0
// 0.125 * 4 * 8 = 4 eighths = half block on cell 0.
render_progress_bar(&mut buf, 0, 0, 4, 0.125, Color::White, Color::Black);
assert_eq!(buf[(0, 0)].symbol(), "▌"); // 4/8 = half
assert_eq!(buf[(0, 0)].symbol(), "▌");
assert_eq!(buf[(1, 0)].symbol(), " ");
}
@@ -164,7 +163,8 @@ mod tests {
// The two glyph tables must share the same index domain so call
// sites can swap them without branching on the host.
assert_eq!(BLOCKS.len(), SHADES.len());
assert_eq!(BLOCKS[0], SHADES[0]); // both empty
assert_eq!(BLOCKS[8], SHADES[8]); // both full block
// Index 0 is empty, index 8 is the full block, in both tables.
assert_eq!(BLOCKS[0], SHADES[0]);
assert_eq!(BLOCKS[8], SHADES[8]);
}
}