From 8ca1b65af6caccab84876816c27036c185c289c8 Mon Sep 17 00:00:00 2001
From: Sebastian Bogan <sebogh@qibli.net>
Date: Sun, 26 Jun 2022 14:45:49 +0200
Subject: [PATCH] fixed docu

---
 dag.go | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/dag.go b/dag.go
index 0917d9c..a2c39ab 100644
--- a/dag.go
+++ b/dag.go
@@ -891,9 +891,10 @@ type FlowResult struct {
 // should return a result or an error.
 type FlowCallback func(d *DAG, id string, parentResults []FlowResult) (interface{}, error)
 
-// DescendantsFlow traverses descendants of the given start vertex (startID). For
-// each descendant it executes the given (callback-) function (FlowCallback), if all parents
-// have finished their work. The
+// DescendantsFlow traverses descendants of the vertex with the ID startID. For
+// the vertex itself and each of its descendant it executes the given (callback-)
+// function providing it the results of its respective parents. The (callback-)
+// function is only executed after all parents have finished their work.
 func (d *DAG) DescendantsFlow(startID string, inputs []FlowResult, callback FlowCallback) ([]FlowResult, error) {
 	d.muDAG.RLock()
 	defer d.muDAG.RUnlock()