From 156c6b8db8be9025389cb68bd47cde2feea5b933 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Damir=20Jeli=C4=87?= <poljar@termina.org.uk>
Date: Tue, 18 Feb 2020 14:45:03 +0100
Subject: [PATCH] EventIndex: Document the return value of the isValidEvent
 method.

---
 src/indexing/EventIndex.js | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/indexing/EventIndex.js b/src/indexing/EventIndex.js
index 475509c2bc..1d85d83f07 100644
--- a/src/indexing/EventIndex.js
+++ b/src/indexing/EventIndex.js
@@ -247,6 +247,8 @@ export default class EventIndex extends EventEmitter {
      * or aren't of a type that we know how to index.
      *
      * @param {MatrixEvent} ev The event that should checked.
+     * @returns {bool} Returns true if the event can be indexed, false
+     * otherwise.
      */
     isValidEvent(ev) {
         const validEventType = ([