doc

rrgmc · Oct 14, 2023 · 19edcd1 · 19edcd1
1 parent 1dbb189
commit 19edcd1
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/generator.go b/generator.go
@@ -2,7 +2,7 @@ package debefix
 
 import "io/fs"
 
-// Generate loads files and calls a resolver callback to resolve the values.
+// Generate loads files and calls a resolver callback to resolve the values, and returns the resolved data.
 // It is a combination of [Load] and [Resolve].
 func Generate(fileProvider FileProvider, resolver ResolveCallback, options ...GenerateOption) (*Data, error) {
 	return generate(func(g *generator) FileProvider {

diff --git a/resolver.go b/resolver.go
@@ -9,7 +9,8 @@ import (
 	"github.com/google/uuid"
 )
 
-// Resolve calls a callback for each table row, taking table dependency in account.
+// Resolve calls a callback for each table row, taking table dependency in account,
+// and returns the resolved data.
 func Resolve(data *Data, f ResolveCallback, options ...ResolveOption) (*Data, error) {
 	r := &resolver{data: data}
 	for _, opt := range options {