core/go-store
8
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions 2

docs(store): clarify workspace lifecycle comments

Browse source 
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
Virgil 2026-04-03 06:39:35 +00:00
parent 2d9c5b2b49
commit f9a7e542bf
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
workspace.go
View file

@ -32,6 +32,8 @@ FROM workspace_entries`
var defaultWorkspaceStateDirectory = ".core/state"
// Workspace is a named SQLite buffer for mutable work-in-progress.
//
// Usage example: `workspace, err := storeInstance.NewWorkspace("scroll-session-2026-03-30"); if err != nil { return }; defer workspace.Discard()`
type Workspace struct {
name string
@ -72,6 +74,7 @@ func (workspace *Workspace) ensureReady(operation string) error {
}
// Usage example: `workspace, err := storeInstance.NewWorkspace("scroll-session-2026-03-30")`
// The backing file lives at `.core/state/scroll-session-2026-03-30.duckdb`.
func (storeInstance *Store) NewWorkspace(name string) (*Workspace, error) {
if err := storeInstance.ensureReady("store.NewWorkspace"); err != nil {
return nil, err