From d844d8e36de0474408c3b2de31b4df286028a72a Mon Sep 17 00:00:00 2001
From: Pragmatic Software <pragma78@gmail.com>
Date: Tue, 6 Jul 2021 19:13:17 -0700
Subject: [PATCH] EventDispatcher: clarify just a bit more

---
 PBot/EventDispatcher.pm | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/PBot/EventDispatcher.pm b/PBot/EventDispatcher.pm
index a24c9cde..2387ae77 100644
--- a/PBot/EventDispatcher.pm
+++ b/PBot/EventDispatcher.pm
@@ -105,7 +105,10 @@ sub dispatch_event {
         }
     }
 
-    # return event handler result
+    # return dispatch result. if at least one event handler returned a defined
+    # value, then this event is considered handled. if there were no handlers
+    # or if all of the available handers returned undef then this value will
+    # be undef.
     return $dispatch_result;
 }