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

+6 -9
View File
@@ -7,9 +7,7 @@ use async_trait::async_trait;
use crate::prompt::CompactionPrompt;
// ---------------------------------------------------------------------------
// Sampler output + error types
// ---------------------------------------------------------------------------
/// Raw text captured from a compaction LLM call, split by channel.
///
@@ -45,16 +43,17 @@ pub enum CompactionSampleError {
Build(String),
/// The sampling call could not be started.
///
/// Classification is asymmetric for pre-migration parity: the *inter*
/// retry policy ([`Self::is_deterministic`]) treats it as deterministic
/// (no retry), while the *intra* orchestrator maps it to
/// Classification is asymmetric: the *inter* retry policy
/// ([`Self::is_deterministic`]) treats it as deterministic (no retry),
/// while the *intra* orchestrator maps it to
/// `IntraCompactionError::SamplerStart` which its retry loop treats as
/// transient.
Start(String),
/// The model produced no response-channel content. Transient.
EmptyResponse,
/// Anything else — classified by string matching for backward
/// compatibility with samplers that pre-date the structured variants.
/// Opaque error — classified by string matching when the sampler does not
/// use a structured variant. Keep match literals in sync with the harness
/// sampler (`compaction_sample_error_to_intra*` tests guard the mapping).
Other(anyhow::Error),
}
@@ -103,9 +102,7 @@ impl CompactionSampleError {
}
}
// ---------------------------------------------------------------------------
// Sampler trait
// ---------------------------------------------------------------------------
/// Interface for the LLM call that produces compaction summaries.
///