Update jsdoc for moveTag

This commit is contained in:
lukebarnard 2018-01-16 09:46:48 +00:00
parent f7e2e91df5
commit d2e5b12271

View file

@ -22,11 +22,12 @@ const TagOrderActions = {};
/** /**
* Creates an action thunk that will do an asynchronous request to * Creates an action thunk that will do an asynchronous request to
* commit TagOrderStore.getOrderedTags() to account data and dispatch * move a tag in TagOrderStore to destinationIx.
* actions to indicate the status of the request.
* *
* @param {MatrixClient} matrixClient the matrix client to set the * @param {MatrixClient} matrixClient the matrix client to set the
* account data on. * account data on.
* @param {string} tag the tag to move.
* @param {number} destinationIx the new position of the tag.
* @returns {function} an action thunk that will dispatch actions * @returns {function} an action thunk that will dispatch actions
* indicating the status of the request. * indicating the status of the request.
* @see asyncAction * @see asyncAction