From 477e115eff9ec8da9de329ec5c42974532e8c4b6 Mon Sep 17 00:00:00 2001
From: Michael Poole <mdpoole@troilus.org>
Date: Sat, 3 Jan 2009 15:37:28 -0500
Subject: [PATCH] Add a comment on why topic change handlers return int.

src/hash.c (SetChannelTopic): Add the comment.
---
 src/hash.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/hash.c b/src/hash.c
index 5cb7b0c..a4dd6fb 100644
--- a/src/hash.c
+++ b/src/hash.c
@@ -702,6 +702,10 @@ SetChannelTopic(struct chanNode *channel, struct userNode *user, const char *top
         irc_topic(user, channel, topic);
     } else {
         for (n=0; n<tf_used; n++)
+            /* A topic change handler can return non-zero to indicate
+             * that it has reverted the topic change, and that further
+             * hooks should not be called.
+             */
             if (tf_list[n](user, channel, old_topic))
                 break;
     }
-- 
2.20.1