From 950f591b3f1a2c8bcb9a25380880b29e2cb06b65 Mon Sep 17 00:00:00 2001 From: Luke Barnard Date: Wed, 13 Dec 2017 15:50:20 +0000 Subject: [PATCH] Clarify more docs --- src/actions/MatrixActionCreators.js | 4 ++-- src/components/structures/TagPanel.js | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/actions/MatrixActionCreators.js b/src/actions/MatrixActionCreators.js index e82ca41d70..33bdb53799 100644 --- a/src/actions/MatrixActionCreators.js +++ b/src/actions/MatrixActionCreators.js @@ -86,8 +86,8 @@ export default { * @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 - * when given the arguments emitted in the MatrixClient - * event. + * when given the MatrixClient as an argument as well as + * arguments emitted in the MatrixClient event. */ _addMatrixClientListener(matrixClient, eventName, actionCreator) { const listener = (...args) => { diff --git a/src/components/structures/TagPanel.js b/src/components/structures/TagPanel.js index 74383bfea5..49d22d8e52 100644 --- a/src/components/structures/TagPanel.js +++ b/src/components/structures/TagPanel.js @@ -36,7 +36,9 @@ const TagPanel = React.createClass({ getInitialState() { return { - // A list of group profiles for group tags + // A list of group profiles for tags that are group IDs. The intention in future + // is to allow arbitrary tags to be selected in the TagPanel, not just groups. + // For now, it suffices to maintain a list of ordered group profiles. orderedGroupTagProfiles: [ // { // groupId: '+awesome:foo.bar',{