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

+6 -3
View File
@@ -320,7 +320,8 @@ mod tests {
#[test]
fn opaque_background_fills_empty_region() {
let mut p = params(0, 10_000); // 1x => 100x50 so pixel coords are exact
// 1x => 100x50 so pixel coords are exact
let mut p = params(0, 10_000);
p.background = Some(Rgba::new(255, 0, 0, 255));
let out = rasterize(SVG_100X50, &p).expect("rasterize");
let img = image::load_from_memory(&out.png)
@@ -440,7 +441,8 @@ mod tests {
#[test]
fn non_finite_or_non_positive_scale_clamps_to_valid_png() {
for bad_scale in [0.0_f32, -1.0, f32::NAN, f32::INFINITY] {
let mut p = params(0, 10_000); // target_width_px == 0 => scale path
// target_width_px == 0 => scale path
let mut p = params(0, 10_000);
p.scale = bad_scale;
let out = rasterize(SVG_100X50, &p)
.unwrap_or_else(|e| panic!("scale {bad_scale} should clamp to 1.0, got {e:?}"));
@@ -490,7 +492,8 @@ mod tests {
// point at the bundled face the glyphs are silently dropped and node
// labels render blank. Black text on white: assert dark pixels exist.
let svg = r##"<svg xmlns="http://www.w3.org/2000/svg" width="200" height="60" viewBox="0 0 200 60"><text x="10" y="38" font-family="Inter, ui-sans-serif, system-ui, -apple-system, &quot;Segoe UI&quot;, sans-serif" font-size="28" fill="#000000">Hello</text></svg>"##;
let mut p = params(0, 10_000); // scale 1.0 => 200x60
// scale 1.0 => 200x60
let mut p = params(0, 10_000);
p.background = Some(Rgba::new(255, 255, 255, 255));
let out = rasterize(svg, &p).expect("rasterize");
let img = image::load_from_memory(&out.png)