From a653ece99e089c602b861f07d7c2c717606e5905 Mon Sep 17 00:00:00 2001 From: lukebarnard Date: Wed, 13 Dec 2017 11:03:21 +0000 Subject: [PATCH] Doc commitTagOrdering --- src/actions/TagOrderActions.js | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/actions/TagOrderActions.js b/src/actions/TagOrderActions.js index 8b79f88276..00f724d9a2 100644 --- a/src/actions/TagOrderActions.js +++ b/src/actions/TagOrderActions.js @@ -20,6 +20,16 @@ import TagOrderStore from '../stores/TagOrderStore'; const TagOrderActions = {}; +/** + * Create a TagOrderActions.commitTagOrdering action that represents an + * asyncronous request to commit TagOrderStore.getOrderedTags() to account + * data. + * + * @param {MatrixClient} matrixClient the matrix client to set the account + * data on. + * @returns {function} an asyncronous action of type + * TagOrderActions.commitTagOrdering. + */ TagOrderActions.commitTagOrdering = function(matrixClient) { return asyncAction('TagOrderActions.commitTagOrdering', () => { // Only commit tags if the state is ready, i.e. not null