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:
@@ -1258,10 +1258,9 @@ mod tests {
|
||||
assert_eq!(rows[1].state, RowState::Working);
|
||||
assert_eq!(rows[2].state, RowState::Idle);
|
||||
}
|
||||
/// Renamed from `sort_deterministic_with_equal_keys`.
|
||||
/// The original name implied a tiebreak guarantee that
|
||||
/// `sort_cluster_key` does NOT provide; documents the actual
|
||||
/// behavioural contract: idempotent on identical inputs.
|
||||
/// `sort_cluster_key` does not guarantee a full tiebreak by itself;
|
||||
/// this asserts the weaker contract it does provide: idempotent on
|
||||
/// identical inputs.
|
||||
#[test]
|
||||
fn sort_is_idempotent_for_identical_inputs() {
|
||||
let now = SystemTime::now();
|
||||
@@ -1737,9 +1736,8 @@ mod tests {
|
||||
AgentView::new(session, ScrollbackState::new())
|
||||
}
|
||||
/// An idle local agent with no last message has a BLANK second line —
|
||||
/// the model is no longer used as a fallback there (it now shows in
|
||||
/// the peek panel's bottom-border badge for the selected row, keeping
|
||||
/// the list uncluttered).
|
||||
/// the model appears in the peek panel's bottom-border badge for the
|
||||
/// selected row instead, keeping the list uncluttered.
|
||||
#[test]
|
||||
fn idle_local_agent_without_message_has_blank_secondary() {
|
||||
let agent = make_idle_agent_with_model(Some("kigi-4.5"));
|
||||
|
||||
Reference in New Issue
Block a user