aboutsummaryrefslogtreecommitdiffhomepage
path: root/internal/store/store.go
diff options
context:
space:
mode:
Diffstat (limited to 'internal/store/store.go')
-rw-r--r--internal/store/store.go3
1 files changed, 2 insertions, 1 deletions
diff --git a/internal/store/store.go b/internal/store/store.go
index 4383d55f..eb9cec41 100644
--- a/internal/store/store.go
+++ b/internal/store/store.go
@@ -179,7 +179,8 @@ func (s *Store) Segments() (iter.Seq[SegmentIdentity], int, error) {
}
// All returns a non-reusable iterator over all [EntryHandle] known to this
-// [Store].
+// [Store]. The resulting handles may be retained, but are only safe to use
+// during the iteration producing them.
//
// Callers must call copyError after completing iteration and handle the error
// accordingly. A non-nil error returned by copyError is of type [hst.AppError].