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

@@ -156,7 +156,8 @@ pub fn split_into_line_segments<'a>(input: &'a str, term_width: usize) -> Vec<Li
push_segment!(segment_end, false);
segment_start = segment_end;
segment_end += char_bytes;
visual_width = char_width; // Reset to just this character's width
// Reset to just this character's width
visual_width = char_width;
has_visual = true;
// Very unlikely edge case: char_width > term size and we have to flush it again
if char_width > term_width {
@@ -316,7 +317,8 @@ mod tests {
#[test]
fn test_wrap_at_exact_width() {
let input = "12345678"; // exactly 8 chars
// exactly 8 chars
let input = "12345678";
let segments = split_into_line_segments(input, 8);
assert_eq!(segments.len(), 1);
assert_eq!(segments[0].content, "12345678");
@@ -364,9 +366,11 @@ mod tests {
// "你好" is 4 visual width (2 per character)
let input = "hello 你好";
let segments = split_into_line_segments(input, 10);
assert_eq!(segments.len(), 1); // "hello 你好" = 6 + 4 = 10, exactly fits
// "hello 你好" = 6 + 4 = 10, exactly fits
assert_eq!(segments.len(), 1);
let segments2 = split_into_line_segments(input, 9);
assert_eq!(segments2.len(), 2); // Doesn't fit, must wrap
// Doesn't fit, must wrap
assert_eq!(segments2.len(), 2);
}
}