Skip to content

Commit 192564d

Browse files
committed
Update docs for read functions
1 parent e6ddc52 commit 192564d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

omnipaxos/src/omni_paxos.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ where
259259
self.seq_paxos.snapshot(compact_idx, local_only)
260260
}
261261

262-
/// Return the decided index.
262+
/// Return the decided index. 0 means that no entry has been decided.
263263
pub fn get_decided_idx(&self) -> usize {
264264
self.seq_paxos.get_decided_idx()
265265
}
@@ -323,7 +323,7 @@ where
323323
.expect("storage error while trying to read log entries")
324324
}
325325

326-
/// Read all decided entries from `from_idx` in the log. Returns `None` if `from_idx` is out of bounds.
326+
/// Read all decided entries starting at `from_idx` (inclusive) in the log. Returns `None` if `from_idx` is out of bounds.
327327
pub fn read_decided_suffix(&self, from_idx: usize) -> Option<Vec<LogEntry<T>>> {
328328
self.seq_paxos
329329
.internal_storage

0 commit comments

Comments
 (0)