add warning to Node.Parents

earthboundkid · earthboundkid · commit e8797ff4782b · 2024-06-22T15:29:35.000-04:00
diff --git a/html/iter.go b/html/iter.go
@@ -51,6 +51,8 @@ func (n *Node) All() iter.Seq[*Node] {
 }
 
 // Parents returns an sequence yielding the node and its parents.
+//
+// Mutating a Node while iterating through it or its parents may have unexpected results.
 func (n *Node) Parents() iter.Seq[*Node] {
 	return func(yield func(*Node) bool) {
 		for p := n; p != nil; p = p.Parent {

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,8 @@ func (n Node) All() iter.Seq[Node] {`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`// Parents returns an sequence yielding the node and its parents.`
	`54`	`+//`
	`55`	`+// Mutating a Node while iterating through it or its parents may have unexpected results.`
`54`	`56`	`func (n Node) Parents() iter.Seq[Node] {`
`55`	`57`	`return func(yield func(*Node) bool) {`
`56`	`58`	`for p := n; p != nil; p = p.Parent {`