Clarify what an event is

tinkerbell · Oct 26, 2023 · 735333c · 735333c
1 parent b71e4cd
commit 735333c
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/internal/agent/event/event.go b/internal/agent/event/event.go
@@ -7,8 +7,9 @@ import "context"
 // Name is a unique name identifying an event.
 type Name string
 
-// Event is a recordable event. Each event in the event package implements this interface. Consumers
-// should type switch the Event to the appropriate type for event handling.
+// Event is a Workflow event created as Workflows execute. Each event in the event package
+// implements this interface. Consumers should type switch the Event to the appropriate type for
+// event handling.
 //
 // E.g.
 //