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:
2026-07-23 16:55:39 -04:00
parent ff0fb56c67
commit a02b555e66
1458 changed files with 10729 additions and 21750 deletions
@@ -60,7 +60,7 @@ pub fn pick_and_advance(tips: &[String], kigi_home: &Path) -> Option<String> {
mod tests {
use super::*;
// ── pick_and_advance ──────────────────────────────────────────────────────
// pick_and_advance
#[test]
fn empty_list_returns_none() {
@@ -98,9 +98,11 @@ mod tests {
fn cursor_persists_across_calls() {
let dir = tempfile::tempdir().unwrap();
let tips = vec!["x".to_string(), "y".to_string()];
pick_and_advance(&tips, dir.path()); // cursor → 1
// cursor → 1
pick_and_advance(&tips, dir.path());
assert_eq!(load_cursor(dir.path()), 1);
pick_and_advance(&tips, dir.path()); // cursor → 2
// cursor → 2
pick_and_advance(&tips, dir.path());
assert_eq!(load_cursor(dir.path()), 2);
}
@@ -119,9 +121,12 @@ mod tests {
let dir = tempfile::tempdir().unwrap();
// Start with 3 tips, advance cursor to 3
let tips3 = vec!["a".to_string(), "b".to_string(), "c".to_string()];
pick_and_advance(&tips3, dir.path()); // cursor 0 → 1
pick_and_advance(&tips3, dir.path()); // cursor 1 → 2
pick_and_advance(&tips3, dir.path()); // cursor 23
// cursor 0 → 1
pick_and_advance(&tips3, dir.path());
// cursor 12
pick_and_advance(&tips3, dir.path());
// cursor 2 → 3
pick_and_advance(&tips3, dir.path());
// remote settings pushes a 5-tip list; cursor=3, 3%5=3 → "d"
let tips5 = vec![
@@ -134,7 +139,7 @@ mod tests {
assert_eq!(pick_and_advance(&tips5, dir.path()).as_deref(), Some("d"));
}
// ── load_cursor / save_cursor ─────────────────────────────────────────────
// load_cursor / save_cursor
#[test]
fn load_cursor_returns_zero_for_corrupt_file() {