Underflow panic doc

iotaledger · Apr 29, 2022 · 1afb083 · 1afb083
1 parent fb98cbd
commit 1afb083
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/bee-ledger/src/workers/pruning/condition.rs b/bee-ledger/src/workers/pruning/condition.rs
@@ -112,6 +112,8 @@ pub(crate) fn should_prune<S: StorageBackend>(
         if *ledger_index < target_index_threshold {
             Err(PruningSkipReason::BelowTargetIndexThreshold)
         } else {
+            // Panic: cannot underflow due to ledger_size >= target_index_threshold = pruning_index +
+            // milestones_to_keep.
             let target_pruning_index = *ledger_index - milestones_to_keep;
 
             Ok(PruningTask::ByIndexRange {