docs(store): clarify declarative constructor guidance
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
parent
089f80c087
commit
4e6a97c119
1 changed files with 3 additions and 2 deletions
5
doc.go
5
doc.go
|
|
@ -5,8 +5,9 @@
|
|||
// Workspace files are created under `.core/state/` and can be recovered with
|
||||
// `RecoverOrphans(".core/state")`.
|
||||
//
|
||||
// Prefer `store.NewConfigured(store.StoreConfig{...})` when constructing a
|
||||
// store from an agent-written configuration literal.
|
||||
// Use `store.NewConfigured(store.StoreConfig{...})` when the database path,
|
||||
// journal, and purge interval are already known.
|
||||
// Keep `store.New(..., store.WithJournal(...))` for incremental assembly.
|
||||
//
|
||||
// Usage example:
|
||||
//
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue