Merge pull request twmb#747 from rrreeezzz/fix/sarama-compat-hasher-doc

docs: update SaramaCompatHasher documentation
sbuliarca · May 28, 2024 · 7641d9e · 7641d9e
2 parents 1c152ac + ac2b9ce
commit 7641d9e
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/pkg/kgo/partitioner.go b/pkg/kgo/partitioner.go
@@ -526,7 +526,16 @@ func SaramaHasher(hashFn func([]byte) uint32) PartitionerHasher {
 //
 // In short, to *exactly* match the Sarama defaults, use the following:
 //
-//	kgo.StickyKeyPartitioner(kgo.SaramaCompatHasher(fnv.New32a()))
+//	kgo.StickyKeyPartitioner(kgo.SaramaCompatHasher(fnv32a))
+//
+// Where fnv32a is a function returning a new 32 bit fnv-1a hasher.
+//
+//	func fnv32a(b []byte) uint32 {
+//		h := fnv.New32a()
+//		h.Reset()
+//		h.Write(b)
+//		return h.Sum32()
+//	}
 func SaramaCompatHasher(hashFn func([]byte) uint32) PartitionerHasher {
 	return func(key []byte, n int) int {
 		p := int32(hashFn(key)) % int32(n)