From 7e817f4aa90a739c4a15e9bb91f874651ee529f9 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Wed, 5 Dec 2018 11:29:53 -0700
Subject: [PATCH] Add a helpful comment

---
 src/stores/RoomViewStore.js | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/stores/RoomViewStore.js b/src/stores/RoomViewStore.js
index 5ddd84c07c..9e048e5d8e 100644
--- a/src/stores/RoomViewStore.js
+++ b/src/stores/RoomViewStore.js
@@ -224,6 +224,8 @@ class RoomViewStore extends Store {
                 err: err,
             });
             let msg = err.message ? err.message : JSON.stringify(err);
+            // XXX: We are relying on the error message returned by browsers here.
+            // This isn't great, but it does generalize the error being shown to users.
             if (msg && msg.startsWith("CORS request rejected")) {
                 msg = _t("There was an error joining the room");
             }