docs: note that the table isnt a source of truth

2026-04-16 21:05:43 -04:00
parent 5452c02d4e
commit d13adcaa49
2 changed files with 4 additions and 1 deletions
--- 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