From fe6b7c0ea2b3ad518d3bbd6f14dbec2c0a31103b Mon Sep 17 00:00:00 2001
From: Luke Barnard <luke@matrix.org>
Date: Wed, 13 Dec 2017 15:43:39 +0000
Subject: [PATCH] Improve _addMatrixClientListener docs

---
 src/actions/MatrixActionCreators.js | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/actions/MatrixActionCreators.js b/src/actions/MatrixActionCreators.js
index 30276e518f..e82ca41d70 100644
--- a/src/actions/MatrixActionCreators.js
+++ b/src/actions/MatrixActionCreators.js
@@ -81,8 +81,8 @@ export default {
     },
 
     /**
-     * Start listening to events emitted by matrixClient, dispatch an action created by the
-     * actionCreator function.
+     * Start listening to events of type eventName on matrixClient and when they are emitted,
+     * dispatch an action created by the actionCreator function.
      * @param {MatrixClient} matrixClient a MatrixClient to register a listener with.
      * @param {string} eventName the event to listen to on MatrixClient.
      * @param {function} actionCreator a function that should return an action to dispatch