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

@@ -1,11 +1,10 @@
//! `scroll-matrix` — scroll validation matrix sweep for kigi-tui.
//!
//! Runs matrix cells (`scroll_matrix::CELLS`) against a real pager binary in
//! a PTY, prints the per-cell verdict table, writes `report.json` into the
//! artifacts dir (next to each cell's recorder capture), and exits nonzero
//! iff any cell failed or an xfail cell passed. The curated tier also runs
//! in CI as `tests/scroll_matrix_curated.rs`; this binary is the local
//! entry point for the full sweep and for one-off cell reruns (`--filter`).
//! Runs matrix cells (`scroll_matrix::CELLS`) against a real pager binary in a
//! PTY and exits nonzero iff any cell failed or an xfail cell passed. The
//! curated tier also runs in CI as `tests/scroll_matrix_curated.rs`; this binary
//! is the local entry point for the full sweep and one-off cell reruns
//! (`--filter`).
use std::path::PathBuf;
use std::process::ExitCode;
@@ -113,8 +112,8 @@ async fn run() -> Result<ExitCode> {
Ok(ExitCode::from(exit_code(&reports)))
}
/// Run every cell, preserving table order. `jobs == 1` runs inline (the
/// representative-timing default); higher values fan out over a semaphore.
/// Reports come back in table order regardless of completion order. `jobs == 1`
/// runs inline, which keeps gesture timing representative.
async fn run_cells(
cells: &[&'static MatrixCell],
jobs: usize,