Update comments

FuelLabs · Jan 8, 2022 · d132470 · d132470
1 parent 6d44a7c
commit d132470
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/common/position.rs b/src/common/position.rs
@@ -175,8 +175,9 @@ impl Position {
         !self.is_leaf()
     }
 
-    /// Given a leaf position and the total count of leaves in a tree, get the path from the path
-    /// from this position to the given leaf.
+    /// Given a leaf position and the total count of leaves in a tree, get the path from this
+    /// position to the given leaf position. The shape of the tree is defined by the `leaves_count`
+    /// parameter and constrains the path.
     /// See [PositionPath](crate::common::PositionPath).
     pub fn path(self, leaf: &Self, leaves_count: u64) -> PositionPath {
         PositionPath::new(self, *leaf, leaves_count)