Improve _addMatrixClientListener docs

This commit is contained in:
Luke Barnard 2017-12-13 15:43:39 +00:00
parent 31ea092d99
commit fe6b7c0ea2

View file

@ -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