Browse Source

wal: add comment

Xiang Li 11 years ago
parent
commit
77fbd2610c
1 changed files with 1 additions and 0 deletions
  1. 1 0
      wal/wal.go

+ 1 - 0
wal/wal.go

@@ -94,6 +94,7 @@ func Create(dirpath string) (*WAL, error) {
 }
 
 // OpenAtIndex opens the WAL at the given index.
+// There MUST be an entry with given index written to WAL before.
 // The returned WAL is ready to read and the first record will be the given
 // index. The WAL cannot be appended to before reading out all of its
 // previous records.