internal/relui: update ApproveActionDep documentation
CL 417220 simplified the implementation not to require repeating
the task name. This change updates the documentation accordingly.
Change-Id: Ie7725562d5a7b131160da5fdc65a7eaecc0ffaf8
Reviewed-on: https://go-review.googlesource.com/c/build/+/419514
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Heschi Kreinick <heschi@google.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
diff --git a/internal/relui/workflows.go b/internal/relui/workflows.go
index d21e211..61bfb63 100644
--- a/internal/relui/workflows.go
+++ b/internal/relui/workflows.go
@@ -534,17 +534,14 @@
//
// ApproveActionDep takes a single *pgxpool.Pool argument, which is
// used to query the database to determine if a task has been marked
-// approved. ApproveActionDep returns a function that accepts a single
-// string argument that must match the name of the task being defined.
-// The returned function is suitable for a single workflow Action with
-// a single dependency.
+// approved. ApproveActionDep returns a function that is suitable
+// for a single workflow Action with a single dependency.
//
// ApproveActionDep marks the task as requiring approval in the
// database once the task is started. This can be used to show an
// "approve" control in the UI.
//
-// actionName := "Wait for Approval"
-// waitAction := wd.Action(actionName, ApproveActionDep(db)(actionName), someDependency)
+// waitAction := wd.Action("Wait for Approval", ApproveActionDep(db), someDependency)
func ApproveActionDep(p *pgxpool.Pool) func(*workflow.TaskContext, interface{}) error {
return AwaitActionDep(5*time.Second, func(ctx *workflow.TaskContext) (done bool, err error) {
return checkTaskApproved(ctx, p)
