From bf13032d5b9c14ab675db164b09a14ca7cb4e0de Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Damir=20Jeli=C4=87?= <poljar@termina.org.uk>
Date: Thu, 4 Jun 2020 15:51:06 +0200
Subject: [PATCH] Searching: Fix a lint issue and expand some docs.

---
 src/Searching.js | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/src/Searching.js b/src/Searching.js
index cb20176804..29556f0757 100644
--- a/src/Searching.js
+++ b/src/Searching.js
@@ -194,12 +194,12 @@ function compareOldestEvents(firstResults, secondResults) {
         const oldestSecondEvent = secondResults.results[secondResults.results.length - 1].result;
 
         if (oldestFirstEvent.origin_server_ts <= oldestSecondEvent.origin_server_ts) {
-            return -1
+            return -1;
         } else {
-            return 1
+            return 1;
         }
     } catch {
-        return 0
+        return 0;
     }
 }
 
@@ -209,6 +209,19 @@ function combineEventSources(previousSearchResult, response, a, b) {
     previousSearchResult.cachedEvents = combinedEvents.slice(SEARCH_LIMIT);
 }
 
+/**
+ * Combine the events from our event sources into a sorted result
+ *
+ * @param {object} previousSearchResult A search result from a previous search
+ * call.
+ * @param {object} localEvents An unprocessed search result from the event
+ * index.
+ * @param {object} serverEvents An unprocessed search result from the server.
+ *
+ * @ return {object} A response object that combines the events from the
+ * different event sources.
+ *
+ */
 function combineEvents(previousSearchResult, localEvents = undefined, serverEvents = undefined) {
     const response = {};