From bd703b17e58041d6e1cdb886af2939d0e30112b3 Mon Sep 17 00:00:00 2001 From: Luke Barnard Date: Tue, 1 May 2018 16:57:28 +0100 Subject: [PATCH] Update documentation for GroupStore.registerListener --- src/stores/GroupStore.js | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/stores/GroupStore.js b/src/stores/GroupStore.js index e750dc1a6b..03132cd80f 100644 --- a/src/stores/GroupStore.js +++ b/src/stores/GroupStore.js @@ -167,11 +167,12 @@ class GroupStore extends EventEmitter { * immediately triggers an update to send the current state of the * store (which could be the initial state). * - * This also causes a fetch of all data of the specified group, - * which might cause 4 separate HTTP requests, but only if said - * requests aren't already ongoing. + * If a group ID is specified, this also causes a fetch of all data + * of the specified group, which might cause 4 separate HTTP + * requests, but only if said requests aren't already ongoing. * - * @param {string} groupId the ID of the group to fetch data for. + * @param {string?} groupId the ID of the group to fetch data for. + * Optional. * @param {function} fn the function to call when the store updates. * @return {Object} tok a registration "token" with a single * property `unregister`, a function that can