Skip to content

Commit

Permalink
clarify docstring for MastForest::remove_nodes
Browse files Browse the repository at this point in the history
  • Loading branch information
plafer committed Aug 20, 2024
1 parent dcd8922 commit c652420
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion core/src/mast/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,10 @@ impl MastForest {
}
}

/// Removes all nodes in the provided set from the MAST forest.
/// Removes all nodes in the provided set from the MAST forest. The nodes MUST be orphaned (i.e.
/// have no parent). Otherwise, this parent's reference is considered "dangling" after the
/// removal (i.e. will point to an incorrect node after the removal), and this removal operation
/// would result in an invalid [`MastForest`].
///
/// It also returns the map from old node IDs to new node IDs; or `None` if the set of nodes to
/// remove was empty. Any [`MastNodeId`] used in reference to the old [`MastForest`] should be
Expand Down

0 comments on commit c652420

Please sign in to comment.