From 389117f1e865275f93c5a99524719fc18911e27e Mon Sep 17 00:00:00 2001
From: Emi Simpson <emi@alchemi.dev>
Date: Fri, 13 Mar 2020 20:59:20 -0400
Subject: [PATCH] Add a comment explaining room importance

---
 src/RoomInfoListItem.cpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/RoomInfoListItem.cpp b/src/RoomInfoListItem.cpp
index 8e4ccbb9..1860881a 100644
--- a/src/RoomInfoListItem.cpp
+++ b/src/RoomInfoListItem.cpp
@@ -327,6 +327,11 @@ RoomInfoListItem::updateUnreadMessageCount(int count, int highlightedCount)
 unsigned short int
 RoomInfoListItem::calculateImportance() const
 {
+        // 0: All messages and minor events read
+        // 1: Contains unread minor events (joins/notices/muted messages)
+        // 2: Contains unread messages
+        // 3: Contains mentions
+        // 4: Is a room invite
         return (hasUnreadMessages_) +
                (unreadHighlightedMsgCount_ + unreadMsgCount_ != 0) +
                (unreadHighlightedMsgCount_ != 0) +