From 9480447637836f0708aec9b049dcc5f0d992a62c Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Wed, 1 Mar 2017 16:09:43 +0000
Subject: [PATCH] Comment stageState

---
 src/interactive-auth.js | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/interactive-auth.js b/src/interactive-auth.js
index 2f6d1ea65..79189c422 100644
--- a/src/interactive-auth.js
+++ b/src/interactive-auth.js
@@ -56,7 +56,9 @@ const MSISDN_STAGE_TYPE = "m.login.msisdn";
  *     called when the status of the UI auth changes, ie. when the state of
  *     an auth stage changes of when the auth flow moves to a new stage.
  *     The arguments are: the login type (eg m.login.password); and an object
- *     specific to the login type.
+ *     specific to the login type. These are:
+ *         m.login.email.identity:
+ *          * emailSid: string, the sid of the active email auth session
  *
  * @param {object?} opts.inputs Inputs provided by the user and used by different
  *     stages of the auto process. The inputs provided will affect what flow is chosen.