From 649edea55195942c5c4fa83e7aac117db01debb9 Mon Sep 17 00:00:00 2001 From: Virgil Date: Sat, 4 Apr 2026 19:28:47 +0000 Subject: [PATCH] docs(ax): align package guidance with declarative config Co-Authored-By: Virgil --- doc.go | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc.go b/doc.go index bc8fea5..3c21636 100644 --- a/doc.go +++ b/doc.go @@ -12,13 +12,13 @@ // // Use `store.NewConfigured(store.StoreConfig{...})` when the database path, // journal, purge interval, or workspace state directory are already known. -// Prefer the struct literal over `store.New(..., store.WithJournal(...))` -// when the full configuration is already available, because it reads as data -// rather than a chain of steps. Use `StoreConfig.Normalised()` when you want -// the default purge interval and workspace state directory filled in before -// you pass the config onward. Use -// `store.WithWorkspaceStateDirectory("/tmp/core-state")` only when the -// workspace path is assembled incrementally rather than declared up front. +// Prefer the struct literal over option chains when the full configuration is +// already available, because it reads as data rather than a sequence of +// steps. Use `StoreConfig.Normalised()` when you want the default purge +// interval and workspace state directory filled in before you pass the config +// onward. Use `store.WithWorkspaceStateDirectory("/tmp/core-state")` only +// when the workspace path is assembled incrementally rather than declared up +// front. // // Usage example: //