diff --git a/settings.go b/settings.go index 6126f64..3301b4f 100644 --- a/settings.go +++ b/settings.go @@ -40,6 +40,9 @@ func Capacity(value int) Option { // MinimumLoad modifies the [DefaultMinimumLoad] of the [Table]. The value must // be between 0.00 and 1.00. +// +// The higher the minimum load, the more likely that a [Table.Put] will not +// succeed. Minimum loads above 20% are not tested. func MinimumLoad(value float64) Option { if value < 0.00 || value > 1.00 { panic(fmt.Sprintf("go-cuckoo: MinimumLoad must be between 0.00 and 1.00, got %f", value))