ZacharyZhang-NY/Kigi-CLI
1
0
Fork 0
Code Issues Pull Requests Actions 13 Packages Projects Releases Wiki Activity

docs(comments): rewrite comments across all crates to the guidelines

Browse Source 
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
2026-07-23 16:55:39 -04:00
parent ff0fb56c67
commit a02b555e66
1458 changed files with 10729 additions and 21750 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/codegen/kigi-tui/benches/search.rs
+11 -13
View File
@@ -1,12 +1,11 @@
//! Criterion benchmarks for scrollback search.
//!
//! - `scan` measures the raw regex scan over a large corpus — the work that ran
//! synchronously on the input thread on every keystroke before the background
//! daemon, and now runs off-thread.
//! - `query_steady` / `query_cold` measure the UI-thread cost of `update_query`
//! after the daemon change: a steady keystroke only compiles the matcher and
//! enqueues the query (the scan is off-thread), while the cold path also
//! rebuilds and ships the corpus on a content change.
//! - `scan` measures the raw regex scan over a large corpus — the work the
//! daemon runs off the input thread, sparing the UI a per-keystroke scan.
//! - `query_steady` / `query_cold` measure the UI-thread cost of `update_query`:
//! a steady keystroke only compiles the matcher and enqueues the query (the
//! scan is off-thread), while the cold path also rebuilds and ships the corpus
//! on a content change.
use std::hint::black_box;
use std::time::Duration;
@@ -53,9 +52,8 @@ fn build_large_scrollback(entries: usize) -> ScrollbackState {
state
}
/// The regex scan itself — the work the daemon now runs off the input thread
/// (previously this ran synchronously per keystroke). `fox` appears in every
/// entry, the worst case for match collection.
/// The regex scan itself — the corpus work the daemon runs off the input
/// thread. `fox` appears in every entry, the worst case for match collection.
fn bench_scan(c: &mut Criterion) {
let state = build_large_scrollback(CORPUS_ENTRIES);
let mut index = ScrollbackSearchIndex::new();
@@ -71,9 +69,9 @@ fn bench_scan(c: &mut Criterion) {
g.finish();
}
/// Steady keystroke after the daemon: the corpus is already shipped, so
/// `update_query` just compiles the matcher and enqueues the query, and `poll`
/// picks up the async result — no scan on the UI thread.
/// Steady keystroke: the corpus is already shipped, so `update_query` just
/// compiles the matcher and enqueues the query, and `poll` picks up the async
/// result — no scan on the UI thread.
fn bench_query_steady(c: &mut Criterion) {
let state = build_large_scrollback(CORPUS_ENTRIES);
let mut search = ScrollbackSearchState::open();