From daef8f329bfd705ded000a5e3ca365d307d561ee Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Damir=20Jeli=C4=87?= <poljar@termina.org.uk>
Date: Wed, 10 Jun 2020 10:34:11 +0200
Subject: [PATCH] Searching: Explain what the integer lists in the
 combineEvents docs mean.

---
 src/Searching.js | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/Searching.js b/src/Searching.js
index be5e61aca7..e580102232 100644
--- a/src/Searching.js
+++ b/src/Searching.js
@@ -234,6 +234,11 @@ function combineEventSources(previousSearchResult, response, a, b) {
  * need keep on looking for the oldest event. We are implementing a variation of
  * a sliding window.
  *
+ * The event sources are here represented as two sorted lists where the lowest
+ * number represents the newest event. The two sorted lists need to be merged
+ * so they can be shown as one search result. We first fetch SEARCH_LIMIT events
+ * from both sources.
+ *
  * If we set SEARCH_LIMIT to 3:
  *
  *  Server events [01, 02, 04, 06, 07, 08, 11, 13]