From 3a98baa0121af4f8535391fad02d9316a13d4db0 Mon Sep 17 00:00:00 2001 From: Harlow Ward Date: Mon, 2 Sep 2019 07:26:44 -0700 Subject: [PATCH] Update godoc for allgroup description --- allgroup.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/allgroup.go b/allgroup.go index 9aee0bd..9b803db 100644 --- a/allgroup.go +++ b/allgroup.go @@ -21,8 +21,9 @@ func NewAllGroup(ksis kinesisiface.KinesisAPI, store Store, streamName string, l } } -// AllGroup caches a local list of the shards we are already processing -// and routinely polls the stream looking for new shards to process +// AllGroup is used to consume all shards from a single consumer. It +// caches a local list of the shards we are already processing +// and routinely polls the stream looking for new shards to process. type AllGroup struct { ksis kinesisiface.KinesisAPI streamName string