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 parent
ff0fb56c67
commit
a02b555e66
1458 files changed
+10729
-21750
No files matched your search
@@ -1,25 +1,17 @@
|
||||
//! SQL schema constants for the memory index.
|
||||
//!
|
||||
//! The index uses three tables:
|
||||
//! - `meta` — key-value metadata (embedding dimensions, schema version)
|
||||
//! - `chunks` — indexed text chunks with blake3 content hashes
|
||||
//! - `chunks_fts` — contentless FTS5 virtual table for BM25 keyword search
|
||||
//!
|
||||
//! When sqlite-vec is available, a fourth table is created:
|
||||
//! - `chunks_vec` — vec0 virtual table for KNN vector search
|
||||
//! SQL schema for the memory index: `meta` key-value settings, `chunks` text
|
||||
//! with blake3 content hashes, a contentless FTS5 `chunks_fts` for BM25
|
||||
//! keyword search, and — only when sqlite-vec loaded — a vec0 `chunks_vec`
|
||||
//! for KNN vector search.
|
||||
|
||||
/// Schema version. Bump when making breaking schema changes that require
|
||||
/// dropping and recreating tables.
|
||||
/// Bump on a breaking change that requires dropping and recreating tables.
|
||||
pub const SCHEMA_VERSION: u32 = 1;
|
||||
|
||||
/// Generate the SQL schema for the memory index.
|
||||
/// `dimensions` sizes the `chunks_vec` embedding column; when `vec_available`
|
||||
/// is false that table is omitted entirely.
|
||||
///
|
||||
/// `dimensions` controls the embedding vector size for `chunks_vec`.
|
||||
/// If `vec_available` is false, the `chunks_vec` table is not created.
|
||||
///
|
||||
/// Connection pragmas (busy_timeout, journal_mode) are applied on the open
|
||||
/// path (`kigi_sqlite_journal::JournalMode::open`) — the journal mode depends
|
||||
/// on the database's filesystem.
|
||||
/// Connection pragmas (busy_timeout, journal_mode) deliberately live on the
|
||||
/// open path (`kigi_sqlite_journal::JournalMode::open`) instead of here,
|
||||
/// because the journal mode depends on the database's filesystem.
|
||||
pub fn schema_sql(dimensions: usize, vec_available: bool) -> String {
|
||||
let mut sql = r#"
|
||||
CREATE TABLE IF NOT EXISTS meta (
|
||||
@@ -62,10 +54,8 @@ INSERT OR IGNORE INTO meta(key, value) VALUES ('reindex_claim', '');
|
||||
sql
|
||||
}
|
||||
|
||||
/// SQL to insert or update an embedding dimension record in the meta table.
|
||||
pub const UPSERT_META_SQL: &str = "INSERT OR REPLACE INTO meta(key, value) VALUES (?1, ?2)";
|
||||
|
||||
/// SQL to query a meta value by key.
|
||||
pub const GET_META_SQL: &str = "SELECT value FROM meta WHERE key = ?1";
|
||||
|
||||
#[cfg(test)]
|
||||
|
||||
Reference in new issue
Block a user