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:
@@ -1,6 +1,5 @@
|
||||
//! Agent builder, definition parsing, and system prompt assembly.
|
||||
//!
|
||||
//! This crate extracts a first-class `Agent` type from `kigi-shell`.
|
||||
//! An `Agent` bundles tools, system prompt, system-reminder policy,
|
||||
//! compaction policy, and model configuration into a single, portable
|
||||
//! object that any host can consume.
|
||||
|
||||
Reference in New Issue
Block a user