document

lestrrat-go · Oct 13, 2024 · 2348ac8 · 2348ac8
1 parent 4e0cc01
commit 2348ac8
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/trie.go b/trie.go
@@ -62,7 +62,9 @@ type Node[K cmp.Ordered, V any] interface {
 	// Parent returns the parent of this node
 	Parent() Node[K, V]
 
-	// Ancestors returns a sequence of ancestors of this node
+	// Ancestors returns a sequence of ancestors of this node.
+	// The first element is the root element, progressing all the way
+	// up to the parent of this node.
 	Ancestors() iter.Seq[Node[K, V]]
 }