From 1696c322a4a9786ee3e6a522e71344c872a45386 Mon Sep 17 00:00:00 2001 From: Al Cutter Date: Fri, 12 Jul 2024 18:02:25 +0100 Subject: [PATCH] Fix comments --- storage/gcp/gcp.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/storage/gcp/gcp.go b/storage/gcp/gcp.go index 2d3d1e51..4d4f2e37 100644 --- a/storage/gcp/gcp.go +++ b/storage/gcp/gcp.go @@ -70,13 +70,15 @@ type objStore interface { setObject(ctx context.Context, obj string, data []byte, cond *gcs.Conditions) error } -// coord describes a type which knows how to sequence entries. +// sequencer describes a type which knows how to sequence entries. type sequencer interface { // assignEntries should durably allocate contiguous index numbers to the provided entries, // and return the lowest assigned index. assignEntries(ctx context.Context, entries [][]byte) (uint64, error) // consumeEntries should call the provided function with up to limit previously sequenced entries. // If the call to consumeFunc returns no error, the entries should be considered to have been consumed. + // If any entries were successfully consumed, the implementation should also return true; this + // serves as a weak hint that there may be more entries to be consumed. consumeEntries(ctx context.Context, limit uint64, f consumeFunc) (bool, error) }