arborist/aborist
russell@unturf.com 92c53c94bb
docs: add docstrings to key modules (CLI, merkle, ingest, store)
Docstring coverage improvements:
- aborist/cli.py: 44/55 functions (80%, was 58%)
  Major command handlers (_cmd_ingest, _cmd_search, _cmd_ask, etc.)
  documented with their purpose.
- aborist/merkle.py: 3/3 classes (100%), 9/10 functions (90%, was 40%)
  Added docstrings to MerkleProof, build(), proof(), root, leaves.
- aborist/ingest.py: 6/7 functions (86%, unchanged)
- aborist/store.py: 17/18 functions (94%, unchanged)

These docstrings enable code-driven documentation generation (via pdoc,
Sphinx, etc.), allowing the deletion of modules.md without losing API
reference coverage. Code + docstrings now serve as the authoritative
module reference.
2026-05-04 07:52:17 -04:00
..
concepts qa(retrieval): documents_fts FTS5 index — title search 1250× faster 2026-05-02 06:57:10 -04:00
distill storage cheats + TF-IDF retrieval fix 2026-04-27 17:24:51 -04:00
mesh mesh: per-peer audit chain-of-claims tracking on the wire 2026-04-28 19:41:25 -04:00
qa qa(#000011 + 4 more): SOFT_PREFLIGHT_HINT impl + 5-task fan-out 2026-05-03 23:00:56 -04:00
search qa(retrieval): synonym-aware FTS5 OR-fallback restores brain-tech surfacing 2026-05-01 22:56:50 -04:00
sources docs: consolidate self-reference design — flat MVP + fact-Core distillation 2026-05-02 12:39:42 -04:00
__init__.py phase 0 explore: aborist core + sources + distill + evict 2026-04-27 07:53:18 -04:00
cli.py docs: add docstrings to key modules (CLI, merkle, ingest, store) 2026-05-04 07:52:17 -04:00
compress.py compress: thread-local zstd contexts; bench: --concurrency flag 2026-05-02 07:36:33 -04:00
document.py phase 0 explore: aborist core + sources + distill + evict 2026-04-27 07:53:18 -04:00
evict.py storage cheats + TF-IDF retrieval fix 2026-04-27 17:24:51 -04:00
ingest.py storage cheats + TF-IDF retrieval fix 2026-04-27 17:24:51 -04:00
journal.py journal: emit unfirehose/1.0 JSONL for queries + bench cycles 2026-05-02 15:19:39 -04:00
merkle.py docs: add docstrings to key modules (CLI, merkle, ingest, store) 2026-05-04 07:52:17 -04:00
progress.py progress reporter + structured benchmark 2026-04-27 11:37:20 -04:00
snapshot.py add corpus-level snapshots: single-hash identity for the forest 2026-04-27 21:29:10 -04:00
source.py phase 0 explore: aborist core + sources + distill + evict 2026-04-27 07:53:18 -04:00
store.py speed: pytest-xdist, bench smoke, concurrency default; UTF surrogate fix 2026-05-02 09:29:40 -04:00
wikitext.py verify: strip wikitext from context before substring matching 2026-04-28 15:48:07 -04:00