From c2c548ef5af57a63b86de10539b39a2844934b23 Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Tue, 2 Aug 2016 18:55:13 +0100
Subject: [PATCH] Comment logout

---
 src/Lifecycle.js | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/Lifecycle.js b/src/Lifecycle.js
index 821cbd189d..9c31f1a20e 100644
--- a/src/Lifecycle.js
+++ b/src/Lifecycle.js
@@ -41,6 +41,9 @@ function setLoggedIn(credentials) {
     startMatrixClient();
 }
 
+/**
+ * Logs the current session out and transitions to the logged-out state
+ */
 function logout() {
     if (MatrixClientPeg.get().isGuest()) {
         // logout doesn't work for guest sessions