diff --git a/doc.go b/doc.go index 3be8bfc..2d1f62f 100644 --- a/doc.go +++ b/doc.go @@ -5,5 +5,8 @@ // a table with any key type using [NewCustom]. Custom [Hash] functions and // key comparison are also supported. // +// NOTE: The [Table] is a look-up structure, and not a source of truth. If +// [ErrBadHash] occurs, the data cannot be restored. +// // See more: https://en.wikipedia.org/wiki/Cuckoo_hashing package cuckoo diff --git a/table.go b/table.go index c869814..105d36e 100644 --- a/table.go +++ b/table.go @@ -9,7 +9,7 @@ import ( ) // ErrBadHash occurs when the hashes given to a [Table] cause too many key -// collisions. Try rebuilding the table using: +// collisions. Discard the old table, rebuild it from your source data, and try: // // 1. Different hash seeds. Equal seeds produce equal hash functions, which // always cycle.