Added documentation to guide

2018-06-14 19:18:48 -07:00
parent 42d7e0869c
commit eb5113af55
2 changed files with 167 additions and 23 deletions
@@ -105,12 +105,11 @@ type KVStore interface {

 	// Iterator over a domain of keys in ascending order. End is exclusive.
 	// Start must be less than end, or the Iterator is invalid.
-	// CONTRACT: No writes may happen within a domain while an iterator exists over it.
+	// To iterate over entire domain -> store.Iterator(nil, nil)
 	Iterator(start, end []byte) Iterator

 	// Iterator over a domain of keys in descending order. End is exclusive.
 	// Start must be greater than end, or the Iterator is invalid.
-	// CONTRACT: No writes may happen within a domain while an iterator exists over it.
 	ReverseIterator(start, end []byte) Iterator

 	// TODO Not yet implemented.