aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2021-07-08 18:31:06 +0200
committerMartin Czygan <martin.czygan@gmail.com>2021-07-08 18:31:06 +0200
commit1ad94cc39ee0a6dfcb1fa19f8603b05df8530ae8 (patch)
tree9c58f4d99d01bb6d64b33598b9866b207be609e6
parent25d39d27118d2b1d1e2f4e02e7988a17fee79031 (diff)
downloadrefcat-1ad94cc39ee0a6dfcb1fa19f8603b05df8530ae8.tar.gz
refcat-1ad94cc39ee0a6dfcb1fa19f8603b05df8530ae8.zip
update docs
-rw-r--r--skate/zipkey/batch.go6
1 files changed, 3 insertions, 3 deletions
diff --git a/skate/zipkey/batch.go b/skate/zipkey/batch.go
index 85d1d35..9924b65 100644
--- a/skate/zipkey/batch.go
+++ b/skate/zipkey/batch.go
@@ -17,7 +17,7 @@ type Batcher struct {
closing bool // https://stackoverflow.com/q/16105325/89391
}
-// NewBatcher set ups a new Batcher.
+// NewBatcher set ups a new Batcher with a batch size of 1000.
func NewBatcher(gf groupFunc) *Batcher {
return NewBatcherSize(gf, 1000)
}
@@ -50,8 +50,8 @@ func (b *Batcher) Close() error {
return b.err
}
-// GroupFunc implement the groupFunc type. Not thread safe. Panics if called
-// after Close.
+// GroupFunc is a drop for a groupFunc. Use this function, where you used
+// grouper before. Not thread safe. Panics if called after Close.
func (b *Batcher) GroupFunc(g *Group) error {
if b.closing {
panic("cannot call GroupFunc after Close")