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:
@@ -37,8 +37,6 @@ use kigi_shell::session::storage::{
|
||||
};
|
||||
use kigi_workspace::session::file_state::{FileSnapshot, FlexiblePath, RewindPoint};
|
||||
|
||||
// ───────────────────────── size knobs ─────────────────────────
|
||||
|
||||
/// Generation parameters. Defaults produce a session large enough that the
|
||||
/// per-phase costs are clearly measurable (tens of MB) while still finishing
|
||||
/// in a few seconds. Scale up via env to approach a real heavy session.
|
||||
@@ -81,8 +79,6 @@ impl GenOpts {
|
||||
}
|
||||
}
|
||||
|
||||
// ───────────────────────── filler ─────────────────────────
|
||||
|
||||
/// Deterministic, non-trivially-compressible-ish filler of `n` bytes. Uses a
|
||||
/// rotating word list so serde has real strings to allocate (not one repeated
|
||||
/// byte), matching the cost profile of real prose/code content.
|
||||
@@ -102,8 +98,6 @@ fn filler(n: usize) -> String {
|
||||
s
|
||||
}
|
||||
|
||||
// ───────────────────────── update synthesis ─────────────────────────
|
||||
|
||||
fn sid(session_id: &str) -> acp::SessionId {
|
||||
acp::SessionId::new(session_id.to_string())
|
||||
}
|
||||
@@ -202,8 +196,6 @@ fn generate_rewind_jsonl(path: &Path, opts: &GenOpts) {
|
||||
std::fs::write(path, out).expect("write rewind_points.jsonl");
|
||||
}
|
||||
|
||||
// ───────────────────────── session setup ─────────────────────────
|
||||
|
||||
/// Find `<root>/sessions/<enc-cwd>/<id>` without depending on the (internal)
|
||||
/// cwd encoder: scan the one level of cwd dirs for a child named `<id>`.
|
||||
fn locate_session_dir(root: &Path, id: &str) -> PathBuf {
|
||||
@@ -223,7 +215,6 @@ fn locate_session_dir(root: &Path, id: &str) -> PathBuf {
|
||||
);
|
||||
}
|
||||
|
||||
/// Recursively copy a directory tree.
|
||||
fn copy_tree(src: &Path, dst: &Path) {
|
||||
std::fs::create_dir_all(dst).unwrap();
|
||||
for entry in std::fs::read_dir(src).unwrap().flatten() {
|
||||
@@ -369,8 +360,6 @@ fn print_kind_breakdown(label: &str, stats: &KindStats) {
|
||||
}
|
||||
}
|
||||
|
||||
// ───────────────────────── TEST 1: phase breakdown ─────────────────────────
|
||||
|
||||
/// Attribute the pre-render load cost to its real phases using the exact
|
||||
/// production functions, isolating rewind-point load from everything else.
|
||||
///
|
||||
@@ -405,14 +394,14 @@ async fn phase_breakdown_real_functions() {
|
||||
.await
|
||||
.expect("load_session_without_updates");
|
||||
let full_load_light = t.elapsed();
|
||||
// load_light no longer reads rewind_points.jsonl (deferred/lazy), so 0 by
|
||||
// construction — `PersistedDataLight` has no rewind field.
|
||||
// load_light does not read rewind_points.jsonl (rewind load is deferred/lazy);
|
||||
// `PersistedDataLight` has no rewind field, so this is 0 by construction.
|
||||
let light_rewind_in_load = 0usize;
|
||||
drop(light);
|
||||
|
||||
// Lazy rewind path (T2): the deferred cost moved here. The picker only needs
|
||||
// a cheap metadata scan; an actual rewind triggers the full content load.
|
||||
// Both read the same file that `load_light` no longer touches.
|
||||
// Lazy rewind path (T2): the picker only needs a cheap metadata scan; an
|
||||
// actual rewind triggers the full content load. Both read the same file
|
||||
// that `load_light` does not touch.
|
||||
use kigi_workspace::session::file_state::FileStateTracker;
|
||||
let t = Instant::now();
|
||||
let lazy_metas = FileStateTracker::with_lazy_source(rewind_path.clone())
|
||||
@@ -504,8 +493,6 @@ fn generate_or_restore_rewind(path: &Path, opts: &GenOpts) {
|
||||
generate_rewind_jsonl(path, opts);
|
||||
}
|
||||
|
||||
// ───────────────────────── TEST 2: true e2e ─────────────────────────
|
||||
|
||||
use std::cell::RefCell;
|
||||
use std::rc::Rc;
|
||||
use std::sync::Arc;
|
||||
|
||||
Reference in New Issue
Block a user