updated cleveldb Iterator API docs to conform to the changes made in #…

…168
cometbft · Aug 9, 2024 · d64f2bb · d64f2bb
1 parent c1d9bc8
commit d64f2bb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/cleveldb_iterator.go b/cleveldb_iterator.go
@@ -95,12 +95,16 @@ func (itr cLevelDBIterator) Valid() bool {
 }
 
 // Key implements Iterator.
+// The caller should not modify the contents of the returned slice.
+// Instead, the caller should make a copy and work on the copy.
 func (itr cLevelDBIterator) Key() []byte {
 	itr.assertIsValid()
 	return itr.source.Key()
 }
 
 // Value implements Iterator.
+// The caller should not modify the contents of the returned slice.
+// Instead, the caller should make a copy and work on the copy.
 func (itr cLevelDBIterator) Value() []byte {
 	itr.assertIsValid()
 	return itr.source.Value()