From 6dd530e2a4b8bb2ebd8d143329b4fa0a6ba833be Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Wed, 4 May 2016 09:41:36 +0100
Subject: [PATCH] Comment getEmailPusher

---
 src/UserSettingsStore.js | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/UserSettingsStore.js b/src/UserSettingsStore.js
index cddf90a1b6..cf7131eb7b 100644
--- a/src/UserSettingsStore.js
+++ b/src/UserSettingsStore.js
@@ -78,6 +78,12 @@ module.exports = {
         return cli.setPassword(authDict, new_password);
     },
 
+    /**
+     * Returns the email pusher (pusher of type 'email') for a given
+     * email address. Email pushers all have the same app ID, so since
+     * pushers are unique over (app ID, pushkey), there will be at most
+     * one such pusher.
+     */
     getEmailPusher: function(pushers, address) {
         if (pushers === undefined) {
             return undefined;