From 30897f05b6e540c6bfa11aec321ae772b2812306 Mon Sep 17 00:00:00 2001
From: Al Cutter <al.cutter@gmail.com>
Date: Thu, 29 Aug 2024 10:26:27 +0000
Subject: [PATCH] Add comment about futures

---
 log.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/log.go b/log.go
index 26c37efa..37a1d35f 100644
--- a/log.go
+++ b/log.go
@@ -46,6 +46,9 @@ type ParseCPFunc func(raw []byte) (*f_log.Checkpoint, error)
 type EntriesPathFunc func(n, logSize uint64) string
 
 // IndexFuture is the signature of a function which can return an assigned index or error.
+//
+// Implementations of this func are likely to be "futures", or a promise to return this data at
+// some point in the future, and as such will block when called if the data isn't yet available.
 type IndexFuture func() (uint64, error)
 
 // StorageOptions holds optional settings for all storage implementations.