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

+9 -6
View File
@@ -199,7 +199,7 @@ mod tests {
use std::time::Duration;
use tempfile::TempDir;
// --- DreamLock tests ---
// DreamLock tests
#[test]
fn no_file_means_no_prior_consolidation() {
@@ -240,7 +240,7 @@ mod tests {
let lock = DreamLock::new(dir.path());
let old_time = SystemTime::now() - Duration::from_secs(7200);
fs::write(&lock.path, "4000000000").unwrap(); // dead PID
fs::write(&lock.path, "4000000000").unwrap();
filetime::set_file_mtime(&lock.path, FileTime::from_system_time(old_time)).unwrap();
let prior = lock
@@ -358,7 +358,8 @@ mod tests {
fn rollback_on_nonexistent_file_is_noop() {
let dir = TempDir::new().unwrap();
let lock = DreamLock::new(dir.path());
lock.rollback(None).unwrap(); // no file to delete, should be fine
// no file to delete, should be fine
lock.rollback(None).unwrap();
}
#[test]
@@ -385,7 +386,7 @@ mod tests {
);
}
// --- sessions_since tests ---
// sessions_since tests
fn write_session(dir: &Path, name: &str, age_secs: u64) {
fs::create_dir_all(dir).unwrap();
@@ -401,8 +402,10 @@ mod tests {
let sessions = dir.path().join("sessions");
let cutoff = SystemTime::now() - Duration::from_secs(3600);
write_session(&sessions, "2026-01-01-proj-aaa11111", 1800); // 30min ago, after cutoff
write_session(&sessions, "2025-12-31-proj-bbb22222", 7200); // 2h ago, before cutoff
// 30min ago, after cutoff
write_session(&sessions, "2026-01-01-proj-aaa11111", 1800);
// 2h ago, before cutoff
write_session(&sessions, "2025-12-31-proj-bbb22222", 7200);
let result = sessions_since(&sessions, cutoff, None).unwrap();
assert_eq!(result, vec!["2026-01-01-proj-aaa11111"]);