doc(echo): Add comment to EmitEvent

Document the reason for emitting the "WORKING" event.
RedHatInsights · Dec 10, 2024 · 293b7ce · 293b7ce
1 parent 55c21b6
commit 293b7ce
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/worker/echo/main.go b/worker/echo/main.go
@@ -37,6 +37,10 @@ func echo(
 	metadata map[string]string,
 	data []byte,
 ) error {
+	// Emit a "WORKING" event, notifying listeners that a significant
+	// event in the worker has occurred. This is optional and may be emitted
+	// whenever appropriate. The data parameter may contain any number of
+	// key/value pairs that will be emitted along with the event.
 	if err := w.EmitEvent(
 		ipc.WorkerEventNameWorking,
 		rcvId,