PR FIXUP - Document HeadFetcher.Start

AndrewSisley · Nov 7, 2024 · 5dd97bb · 5dd97bb
1 parent 1ea2333
commit 5dd97bb
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/internal/db/fetcher/dag.go b/internal/db/fetcher/dag.go
@@ -28,6 +28,12 @@ type HeadFetcher struct {
 	kvIter dsq.Results
 }
 
+// Start starts/initializes the fetcher, performing all the work it can do outside
+// of the main iteration loop/funcs.
+//
+// prefix - Optional. The headstore prefix to scan across.  If None, the entire
+// headstore will be scanned - for example, in order to fetch document and collection
+// heads.
 func (hf *HeadFetcher) Start(
 	ctx context.Context,
 	txn datastore.Txn,