edit comment

Author: dsa0x

bloom.go

@@ -78,7 +78,7 @@ var DefaultBloomOptions = BloomOptions{
 }
 
 // NewBloom creates a new bloom filter.
-// err_rate is the desired false error rate. e.g. 0.001 implies 1 in 1000
+// err_rate is the desired false error rate. e.g. 0.001 implies 1 false positive in 1000 lookups
 //
 // capacity is the number of entries intended to be added to the filter
 //

scalable_bloom.go

@@ -37,7 +37,7 @@ var (
 )
 
 // NewScalableBloom creates a new scalable bloom filter.
-// err_rate is the desired error rate.
+// err_rate is the desired false error rate. e.g. 0.001 implies 1 false positive in 1000 lookups
 // initial_capacity is the initial capacity of the bloom filter. When the number
 // of items exceed the initial capacity, a new filter is created.
 //