From 8ea425d774cdfeae568bc4e977742a2d54692f20 Mon Sep 17 00:00:00 2001 From: Ryan Walls Date: Sat, 2 Jul 2016 11:20:34 -0600 Subject: [PATCH] Update Tick documentation to match the expected behavior --- activity/handler.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/activity/handler.go b/activity/handler.go index cbf65e7..3124d1e 100644 --- a/activity/handler.go +++ b/activity/handler.go @@ -28,10 +28,10 @@ type CoordinatedActivityHandler struct { Start CoordinatedActivityHandlerStartFunc // Tick is called regularly to process a running activity. - // Tick that returns false, nil, nil just expresses that the job is still running. - // Tick that returns false, &SomeStruct{}, nil will express that the job is still running and also send an 'ActivityUpdated' signal back to the FSM with SomeStruct{} as the Input. - // Tick that returns true, &SomeStruct{}, nil, expresses that the job/activity is done and send SomeStruct{} back as the result. as well as stops heartbeating. - // Tick that returns true, nil, nil, expresses that the job is done and send no result back, as well as stops heartbeating. + // Tick that returns true, nil, nil just expresses that the job is still running. + // Tick that returns true, &SomeStruct{}, nil will express that the job is still running and also send an 'ActivityUpdated' signal back to the FSM with SomeStruct{} as the Input. + // Tick that returns false, &SomeStruct{}, nil, expresses that the job/activity is done and send SomeStruct{} back as the result. as well as stops heartbeating. + // Tick that returns false, nil, nil, expresses that the job is done and send no result back, as well as stops heartbeating. // Tick that returns false, nil, err expresses that the job/activity failed and sends back err as the reason. as well as stops heartbeating. Tick CoordinatedActivityHandlerTickFunc