wal: add comment

This commit is contained in:
Xiang Li 2014-09-14 16:53:41 -07:00
parent 1d09c25f5f
commit 77fbd2610c

View File

@ -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.