From d08f7166815a6b100e2145510244f3c504c785fa Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Thu, 18 Aug 2016 15:21:46 +0100
Subject: [PATCH] Comment override rule stuff

---
 src/RoomNotifs.js | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/RoomNotifs.js b/src/RoomNotifs.js
index f545275641..ea1e525769 100644
--- a/src/RoomNotifs.js
+++ b/src/RoomNotifs.js
@@ -69,7 +69,11 @@ function setRoomNotifsStateMuted(roomId) {
         promises.push(cli.deletePushRule('global', 'room', roomRule.rule_id));
     }
 
-    // add an override rule to squelch everything in this room
+    // add/replace an override rule to squelch everything in this room
+    // NB. We use the room ID as the name of this rule too, although this
+    // is an override rule, not a room rule: it still pertains to this room
+    // though, so using the room ID as the rule ID is logical and prevents
+    // duplicate copies of the rule.
     promises.push(cli.addPushRule('global', 'override', roomId, {
         conditions: [
             {