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

@@ -13,7 +13,7 @@ use crate::types::{
/// Commands sent to the HunkTrackerActor via mpsc channel.
#[derive(Debug)]
pub enum HunkTrackerCommand {
// === Mutation Commands (fire-and-forget) ===
// Mutation Commands (fire-and-forget)
/// Agent tool wrote to a file - record it and compute hunks
RecordAgentWrite {
path: PathBuf,
@@ -40,7 +40,7 @@ pub enum HunkTrackerCommand {
/// Set tracking mode
SetMode { mode: TrackingMode },
// === Action Commands (accept/reject hunks) ===
// Action Commands (accept/reject hunks)
/// Apply action (accept/reject) to a specific hunk
HunkAction {
hunk_id: HunkId,
@@ -68,7 +68,7 @@ pub enum HunkTrackerCommand {
reply: oneshot::Sender<Result<Vec<HunkId>, HunkActionError>>,
},
// === Query Commands (request-response via oneshot) ===
// Query Commands (request-response via oneshot)
/// Get all current hunks
GetAllHunks {
reply: oneshot::Sender<Vec<Arc<Hunk>>>,
@@ -121,7 +121,7 @@ pub enum HunkTrackerCommand {
reply: oneshot::Sender<Vec<FileContentEntry>>,
},
// === Session Summary Commands ===
// Session Summary Commands
/// Get complete session summary (stats + pending turns)
GetSessionSummary {
reply: oneshot::Sender<SessionSummary>,
@@ -140,7 +140,7 @@ pub enum HunkTrackerCommand {
/// content from disk. Used after a git HEAD/index change to reconcile stale state.
RefreshAllBaselines,
// === Snapshot / Restore Commands (for cross-session sync-back) ===
// Snapshot / Restore Commands (for cross-session sync-back)
/// Take a snapshot of all hunk tracker state for preservation across
/// session kill/reload cycles.
SnapshotState {
@@ -153,7 +153,7 @@ pub enum HunkTrackerCommand {
reply: oneshot::Sender<HunkTurnDelta>,
},
/// Restore a previously snapshotted state. Replaces all current file
/// Restore a earlier snapshotted state. Replaces all current file
/// states, turn index, and session stats.
RestoreState(HunkTrackerSnapshot),
}