chore: add comments to exported functions

f1zm0 · Apr 20, 2023 · 428e9ba · 428e9ba
1 parent 81bc1f4
commit 428e9ba
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/pkg/hashing/hashing.go b/pkg/hashing/hashing.go
@@ -1,7 +1,9 @@
 package hashing
 
+// HashFunction is a type alias for a function that takes a byte slice and returns a uint64.
 type HashFunction func([]byte) uint64
 
+// DJB2 is an implementation of the djb2 hash function. Ref: http://www.cse.yorku.ca/~oz/hash.html
 func DJB2(s []byte) uint64 {
 	var hash uint64 = 5381
 	for _, c := range s {