shardtree: Correct erroneous ShardStore::get_checkpoint_at_depth do…

…cumentation
zcash · Nov 3, 2023 · fbcaec2 · fbcaec2
1 parent c8351fc
commit fbcaec2
Showing 1 changed file with 3 additions and 3 deletions.
diff --git 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<usize, Self::Error>;
 
-    /// 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,