Skip to content

Commit 26a59a8

Browse files
committed
docs: Link to new bag_peaks method
1 parent 4587a49 commit 26a59a8

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

tasm-lib/src/mmr/bag_peaks.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use crate::prelude::*;
88
use crate::traits::basic_snippet::Reviewer;
99
use crate::traits::basic_snippet::SignOffFingerprint;
1010

11-
/// Bag the peaks of an MMR into a single [`Digest`].
11+
/// [Bag the peaks][bag] of an MMR into a single [`Digest`].
1212
///
1313
/// # Behavior
1414
///
@@ -26,15 +26,15 @@ use crate::traits::basic_snippet::SignOffFingerprint;
2626
///
2727
/// # Postconditions
2828
///
29-
/// - the output is a single [`Digest`] computed like in `bag_peaks` from
30-
/// `twenty-first`
29+
/// - the output is a single [`Digest`] computed like in [`bag_peaks`][bag]
3130
/// - the output is properly [`BFieldCodec`] encoded
3231
///
3332
/// # Crashes
3433
///
3534
/// - if the MMR accumulator is inconsistent, *i.e.*, if the number of peaks
3635
/// does not match the number of set bits in the leaf count
3736
///
37+
/// [bag]: twenty_first::util_types::mmr::mmr_trait::Mmr::bag_peaks
3838
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
3939
pub struct BagPeaks;
4040

0 commit comments

Comments
 (0)