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

Improve documentation of private `extend_to_level` method.

This commit is contained in:
Kris Nuttycombe 2025-02-19 08:42:29 -07:00
parent 1ad56addf7
commit 422889cd5a
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
shardtree/src/prunable.rs
View File

@ -651,9 +651,13 @@ impl<H: Hashable + Clone + PartialEq> LocatedPrunableTree<H> {
} }
} }
// In the case that we are replacing a node entirely, we need to extend the // In the case that we are replacing a node entirely, we need to extend the subtree up to the
// subtree up to the level of the node being replaced, adding Nil siblings // level of the node being replaced, adding Nil siblings and recording the presence of those
// and recording the presence of those incomplete nodes when necessary // incomplete nodes when necessary. The newly created root node will be annotated with the
// provided value.
//
// If the root level of `self` is greater than or equal to the requested level, no extension
// will be performed, but the root node will still be reannotated.
fn extend_to_level( fn extend_to_level(
self, self,
level: Level, level: Level,