masonry: add docs for TreeArena::get_id_path (#573)

beats reading the implementation to know the order :-)
linebender · Sep 3, 2024 · 5944aa5 · 5944aa5
1 parent e337cf7
commit 5944aa5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/masonry/src/tree_arena.rs b/masonry/src/tree_arena.rs
@@ -207,6 +207,10 @@ impl<Item> TreeArena<Item> {
         Some(node.arena_mut(self.parents_map[&id], &mut self.parents_map))
     }
 
+    /// Construct the path of items from the given item to the root of the tree.
+    ///
+    /// The path is in order from the bottom to the top, starting at the given item and ending at
+    /// the root.
     pub fn get_id_path(&self, id: u64) -> Vec<u64> {
         let mut path = Vec::new();