From fbcaec2ab16d33b1c55a6920914150f560ed1669 Mon Sep 17 00:00:00 2001 From: Kris Nuttycombe Date: Fri, 3 Nov 2023 11:09:11 -0600 Subject: [PATCH] shardtree: Correct erroneous `ShardStore::get_checkpoint_at_depth` documentation --- shardtree/src/store.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/shardtree/src/store.rs b/shardtree/src/store.rs index 5095ff2a..eadd1686 100644 --- a/shardtree/src/store.rs +++ b/shardtree/src/store.rs @@ -96,9 +96,9 @@ pub trait ShardStore { /// Returns the number of checkpoints maintained by the data store fn checkpoint_count(&self) -> Result; - /// Returns the position of the checkpoint, if any, along with the number of subsequent - /// checkpoints at the same position. Returns `None` if `checkpoint_depth == 0` or if - /// insufficient checkpoints exist to seek back to the requested depth. + /// Returns the id and position of the checkpoint, if any. Returns `None` if + /// `checkpoint_depth == 0` or if insufficient checkpoints exist to seek back + /// to the requested depth. fn get_checkpoint_at_depth( &self, checkpoint_depth: usize,