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

@@ -30,9 +30,7 @@ async fn replace_file_async(tmp: PathBuf, target: PathBuf) -> io::Result<()> {
/// Used for subagent child sessions whose files live under the parent's session dir.
#[derive(Clone)]
enum SessionDirMode {
/// Existing behavior: root + sessions/{cwd}/{id}/
FromRoot(PathBuf),
/// New: use this directory directly (for subagent children).
Explicit(PathBuf),
}
/// JSONL-based storage adapter (legacy format)
@@ -319,7 +317,6 @@ impl JsonlStorageAdapter {
}
Ok(items)
}
/// Append a session update to the updates.jsonl file, wrapping it in an envelope with timestamp.
async fn append_update_to_file(
&self,
path: PathBuf,
@@ -605,7 +602,6 @@ impl JsonlStorageAdapter {
.map_err(io::Error::other)?
}
}
/// Transform session ID in a SessionUpdate
fn transform_session_id_in_update(
update: super::SessionUpdate,
new_id: &acp::SessionId,
@@ -1968,7 +1968,6 @@ async fn list_sessions_recent_skips_corrupt_summary() {
assert_eq!(recent.len(), 1);
assert_eq!(recent[0].info.id, acp::SessionId::new("good"));
}
/// Helper: set the mtime of a file to a specific chrono DateTime.
fn set_mtime(path: &std::path::Path, time: chrono::DateTime<chrono::Utc>) {
use std::time::{Duration, UNIX_EPOCH};
let secs = time.timestamp() as u64;
@@ -2719,10 +2718,10 @@ async fn append_update_terminates_torn_trailing_line() {
/// End-to-end resume-path regression for the incident: a live session
/// whose `chat_history.jsonl` contains a merged record (crash mid-append,
/// then log-and-continue appended the next record onto the partial line)
/// must still load via `load_session_without_updates` — previously this
/// returned InvalidData ("expected `,` or `}` at line 1 column N"),
/// surfacing to the user as "Couldn't load session: … FS_OTHER" and
/// permanently bricking the session.
/// must still load via `load_session_without_updates` instead of failing
/// with InvalidData ("expected `,` or `}` at line 1 column N"), which
/// surfaced to the user as "Couldn't load session: … FS_OTHER" and
/// permanently bricked the session.
#[tokio::test]
async fn load_session_without_updates_survives_merged_chat_line() {
let temp_dir = TempDir::new().unwrap();