zec
/
incrementalmerkletree
mirror of https://github.com/zcash/incrementalmerkletree.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

incrementalmerkletree: Documentation fix for `Checkpoint` retention. 

Co-authored-by: str4d <thestr4d@gmail.com>
This commit is contained in:
Kris Nuttycombe 2024-05-30 08:04:23 -06:00 committed by GitHub
parent d40e178f8d
commit 93512976dd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
incrementalmerkletree/src/lib.rs
View File

@ -83,7 +83,8 @@ pub enum Retention<C> {
/// A leaf with `Ephemeral` retention will be pruned whenever its sibling is also a leaf with /// A leaf with `Ephemeral` retention will be pruned whenever its sibling is also a leaf with
/// `Ephemeral` retention. /// `Ephemeral` retention.
Ephemeral, Ephemeral,
/// A leaf with `Checkpoint` retention will be retained in the tree during pruning. If /// A leaf with `Checkpoint` retention will have its position retained in the tree
/// during pruning, but its value may be pruned (by merging with its sibling). If
/// `Checkpoint` retention is removed from the leaf, then the retention for the leaf will /// `Checkpoint` retention is removed from the leaf, then the retention for the leaf will
/// become either `Ephemeral`, `Marked`, or `Reference` depending upon the value of the /// become either `Ephemeral`, `Marked`, or `Reference` depending upon the value of the
/// `marking` field. /// `marking` field.