docs(ax): align package guidance with declarative config
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
parent
4c6f2d6047
commit
649edea551
1 changed files with 7 additions and 7 deletions
14
doc.go
14
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:
|
||||
//
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue