From 8094db4f367564042b143643672a16557ed43069 Mon Sep 17 00:00:00 2001
From: Pragmatic Software <pragma78@gmail.com>
Date: Wed, 23 Jun 2021 16:06:15 -0700
Subject: [PATCH] ActionTrigger: improve docs in comment header

---
 Plugins/ActionTrigger.pm | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/Plugins/ActionTrigger.pm b/Plugins/ActionTrigger.pm
index b8fe4750..1fae77e9 100644
--- a/Plugins/ActionTrigger.pm
+++ b/Plugins/ActionTrigger.pm
@@ -1,10 +1,17 @@
 # File: ActionTrigger.pm
 #
 # Purpose: provides interface to set/remove/modify regular expression triggers
-# to execute a command.
+# which invoke bot commands when matched against IRC messages.
 #
 # Usage: actiontrigger add <#channel or global> <capability> <rate-limit (in seconds)> <regex trigger> <command>
 #
+# Note that ActionTrigger does not match on raw IRC lines. It matches on a
+# simplified message format:
+#
+#    "<hostmask> <action> <arguments>"
+#
+# where <action> can be PRIVMSG, ACTION, KICK, JOIN, PART or QUIT.
+#
 # Examples:
 #
 # Greet a nick when they join the channel: