From 5827c25996ad41e7a1ee5941b6df8196874d5d8b Mon Sep 17 00:00:00 2001 From: Dan Cline <6798349+Rjected@users.noreply.github.com> Date: Wed, 3 Jul 2024 06:30:33 -0400 Subject: [PATCH] chore: fix pruner exex height docs, add run docs (#9250) --- crates/prune/prune/src/pruner.rs | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/crates/prune/prune/src/pruner.rs b/crates/prune/prune/src/pruner.rs index 656aa69adeb2..68a1e6751e7b 100644 --- a/crates/prune/prune/src/pruner.rs +++ b/crates/prune/prune/src/pruner.rs @@ -85,7 +85,11 @@ impl Pruner { self.event_sender.new_listener() } - /// Run the pruner + /// Run the pruner. This will only prune data up to the highest finished `ExEx` height, if there + /// are no `ExEx`s, . + /// + /// Returns a [`PruneProgress`], indicating whether pruning is finished, or there is more data + /// to prune. pub fn run(&mut self, tip_block_number: BlockNumber) -> PrunerResult { let Some(tip_block_number) = self.adjust_tip_block_number_to_finished_exex_height(tip_block_number) @@ -306,8 +310,8 @@ impl Pruner { /// Adjusts the tip block number to the finished `ExEx` height. This is needed to not prune more /// data than `ExExs` have processed. Depending on the height: - /// - [`FinishedExExHeight::NoExExs`] returns the tip block number as is as no adjustment for - /// `ExExs` is needed. + /// - [`FinishedExExHeight::NoExExs`] returns the tip block number as no adjustment for `ExExs` + /// is needed. /// - [`FinishedExExHeight::NotReady`] returns `None` as not all `ExExs` have emitted a /// `FinishedHeight` event yet. /// - [`FinishedExExHeight::Height`] returns the finished `ExEx` height.