From 625ca96d864c1da6e4c054680e65c8f34f8996cc Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Thu, 10 Aug 2017 14:01:24 +0100
Subject: [PATCH] add comment about why state key must be not undefined

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
 src/shouldHideEvent.js | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/shouldHideEvent.js b/src/shouldHideEvent.js
index 36aa2ae17d..0eec756390 100644
--- a/src/shouldHideEvent.js
+++ b/src/shouldHideEvent.js
@@ -16,6 +16,7 @@
 
 function memberEventDiff(ev) {
     const diff = {
+        // a Member Event is a State Event and so its State Key must not be undefined.
         isMemberEvent: ev.getType() === 'm.room.member' && ev.getStateKey() !== undefined,
     };