aboutsummaryrefslogtreecommitdiffstats
path: root/skate/zipkey
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2021-03-31 02:36:01 +0200
committerMartin Czygan <martin.czygan@gmail.com>2021-03-31 02:36:01 +0200
commitd66476fac43c83925a6d8a2fe40bf334dcb4331d (patch)
treeac4b8a9c1e70b82cbbc58199e072c92c5e214159 /skate/zipkey
parentb8f6b25f87fe09badab11b3e9e4c55c96588573f (diff)
downloadrefcat-d66476fac43c83925a6d8a2fe40bf334dcb4331d.tar.gz
refcat-d66476fac43c83925a6d8a2fe40bf334dcb4331d.zip
update docs
Diffstat (limited to 'skate/zipkey')
-rw-r--r--skate/zipkey/zipkey.go5
1 files changed, 3 insertions, 2 deletions
diff --git a/skate/zipkey/zipkey.go b/skate/zipkey/zipkey.go
index a03bb28..a9f5c04 100644
--- a/skate/zipkey/zipkey.go
+++ b/skate/zipkey/zipkey.go
@@ -20,8 +20,9 @@ type (
// ZipRun reads records (separated by sep) from two readers, extracts a key
// from each record with a keyFunc and collects records from the two streams
-// into a Group. A callback can be registered, which allows to customize the
-// processing of the group.
+// into a Group. A callback groupFunc can be registered, which allows to
+// customize the processing of the group. Current limitation: both streams need
+// to use the same keyFunc.
type ZipRun struct {
r0, r1 *bufio.Reader
kf keyFunc