From fcd698561864455a4ac4011dde46a08bb031831a Mon Sep 17 00:00:00 2001
From: Jonas Platte <jplatte+git@posteo.de>
Date: Sun, 9 Jul 2017 21:46:45 +1000
Subject: [PATCH] Add more detailed documentation for Client::log_in

---
 src/lib.rs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/lib.rs b/src/lib.rs
index 7536af7a..a49d0969 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -100,7 +100,11 @@ where
         }
     }
 
-    /// Log in to the homeserver with a username and password.
+    /// Log in with a username and password.
+    ///
+    /// In contrast to api::r0::session::login::call(), this method stores the
+    /// session data returned by the endpoint in this client, instead of
+    /// returning it.
     pub fn log_in<'a>(&'a self, user: String, password: String)
     -> impl Future<Item = (), Error = Error> + 'a {
         let request = login::Request {