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 + 'a { let request = login::Request {