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

@@ -1899,7 +1899,8 @@ The frozen lines are **never re-rendered**, making streaming O(N) instead of O(N
let first_splits: Vec<usize> = if first_half.len() > 1 {
vec![first_half.len() / 2]
} else {
vec![first_half.len()] // No split, use whole thing
// No split, use whole thing
vec![first_half.len()]
};
// Split second half (if possible)
@@ -1927,7 +1928,8 @@ The frozen lines are **never re-rendered**, making streaming O(N) instead of O(N
.collect();
if chunks.len() < 2 {
continue; // Need at least 2 chunks
// Need at least 2 chunks
continue;
}
tested += 1;
@@ -2482,9 +2484,7 @@ The frozen lines are **never re-rendered**, making streaming O(N) instead of O(N
assert_streaming_matches_full_both(text);
}
// ----------------------------------------------------------------------
// Syntect-enabled streaming equivalence (incremental open-code highlighter)
// ----------------------------------------------------------------------
/// Build a nested YAML body of at least `num_lines` lines (no fences).
fn yaml_body(num_lines: usize) -> String {
@@ -2866,7 +2866,8 @@ The frozen lines are **never re-rendered**, making streaming O(N) instead of O(N
#[test]
fn clone_preserves_held_back_pending() {
let mut r = StreamingMarkdownRenderer::new(test_style::STYLE, true);
r.push_and_render("ab \\(\\alpha\\) cd \\", None); // trailing `\` held back
// trailing `\` held back
r.push_and_render("ab \\(\\alpha\\) cd \\", None);
let mut cloned = r.clone();
r.push_and_render("(\\beta\\) ef\n\n", None);
cloned.push_and_render("(\\beta\\) ef\n\n", None);