PR FIXUP - Expand Seek documentation

sourcenetwork · Jan 24, 2025 · 54a6e1c · 54a6e1c
1 parent 5e95eb3
commit 54a6e1c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/kv.go b/kv.go
@@ -121,6 +121,10 @@ type Iterator interface {
 
 	// Seek moves the iterator to the given key, if and exact match is not found, the
 	// iterator will progress to the next valid value (depending on the `Reverse` option).
+	//
+	// Seek will not seek to values outside of the constraints provided in [IterOptions],
+	// unless using the badger store due to bug:
+	// https://github.com/sourcenetwork/corekv/issues/38
 	Seek([]byte)
 
 	// Close releases the iterator.