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

+8 -4
View File
@@ -362,8 +362,10 @@ mod tests {
#[test]
fn dirty_store_yields_one_snapshot_then_clears() {
let mut mru = SlashMru::new(); // persist-enabled
mru.loaded = true; // avoid disk read in test
// persist-enabled
let mut mru = SlashMru::new();
// avoid disk read in test
mru.loaded = true;
mru.touch("p", "plan");
assert!(mru.dirty);
assert!(mru.take_persist_snapshot().is_some());
@@ -380,9 +382,11 @@ mod tests {
mru.loaded = true;
mru.touch("p", "plan");
assert!(mru.take_persist_snapshot().is_some());
assert!(mru.take_persist_snapshot().is_none()); // nothing to retry yet
// nothing to retry yet
assert!(mru.take_persist_snapshot().is_none());
mru.mark_dirty();
assert!(mru.take_persist_snapshot().is_some()); // retried
// retried
assert!(mru.take_persist_snapshot().is_some());
}
#[test]