hive-agent: trim narrative comment bloat in doc comments (#3901)

This commit is contained in:
damocles 2026-09-02 01:21:47 +02:00 committed by mara
commit b8d3b95641
4 changed files with 21 additions and 31 deletions

View file

@ -42,26 +42,19 @@ pub fn harness_dir() -> PathBuf {
/// Consolidated harness-local state db — todos + reminders, one table
/// each — mutable per-agent state the harness owns, kept out of the
/// append-only `hyperhive-events.sqlite` sink. Per mara's call ("not yet
/// another sqlite! todos, reminders, questions should be like three tiny
/// tables in one 500kb sqlite"), this file is the shared home for the
/// loose-ends-v2 stores; each store's `open()` only applies its own
/// `CREATE TABLE IF NOT EXISTS`, so opening multiple stores against the
/// same path is safe (distinct table names, no schema collision). Both
/// stores (todos, reminders) open this same path directly (see their
/// `open()` call sites) — distinct table names mean no schema collision,
/// so there's no need for per-store path wrapper fns here.
/// append-only `hyperhive-events.sqlite` sink. Each store's `open()` only
/// applies its own `CREATE TABLE IF NOT EXISTS` against this same path
/// (see their call sites), so distinct table names keep them from
/// colliding without needing a per-store path wrapper here.
///
/// ⚠️ A pre-existing harness may still carry a third table here, `questions`
/// — the mirror this file's own doc comment used to describe as one of
/// three. It's gone now that the ask/answer mechanism itself has been
/// removed: nothing opens or writes it any more, so any rows already in
/// it are inert, harmless leftovers, not a store to migrate or clean up.
/// ⚠️ A pre-existing harness may still carry an inert `questions` table
/// here from the now-removed ask/answer mechanism — nothing opens or
/// writes it, and any rows in it are harmless leftovers, not a store to
/// migrate or clean up.
///
/// Before the todos/reminders consolidation, they lived in their own
/// `hyperhive-todos.sqlite` / `hyperhive-reminders.sqlite` files; a
/// one-time boot migration (`db_migrate::run`) folds those into this path
/// the first time a harness boots after the upgrade.
/// A one-time boot migration (`db_migrate::run`) folds the older
/// `hyperhive-todos.sqlite` / `hyperhive-reminders.sqlite` files into this
/// path on first boot after an upgrade.
#[must_use]
pub fn state_db() -> PathBuf {
harness_dir().join("hyperhive-state.sqlite")