path: clarify update signature

gonum · Aug 31, 2015 · 54da0d4 · 54da0d4
1 parent 0ac8bde
commit 54da0d4
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/path/spanning_tree.go b/path/spanning_tree.go
@@ -119,7 +119,8 @@ func (q *primQueue) key(u graph.Node) (key float64, ok bool) {
 	return q.nodes[i].Weight(), ok
 }
 
-// update updates the node's position in the queue with the new key.
+// update updates u's position in the queue with the new closest
+// MST-connected neighbour, v and the key weight between u and v.
 func (q *primQueue) update(u, v graph.Node, key float64) {
 	id := u.ID()
 	i, ok := q.indexOf[id]