From 372e989ee220cbdfc4dd7fccaf76432b21dae4b0 Mon Sep 17 00:00:00 2001
From: Gergely Polonkai <gergely@polonkai.eu>
Date: Fri, 22 Jan 2016 15:13:47 +0100
Subject: [PATCH] Update documentation of
 matrix_client_register_with_password()

---
 src/matrix-client.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/src/matrix-client.c b/src/matrix-client.c
index 25ff195..947b1f4 100644
--- a/src/matrix-client.c
+++ b/src/matrix-client.c
@@ -85,7 +85,15 @@ matrix_client_login_with_password(MatrixClient *client,
  * @password: the password to use with the registration
  * @error: a location for a #GError, or %NULL
  *
- * Register @username with the homeserver.
+ * Register @username with the homeserver as a normal user.
+ *
+ * Upon success, the user is registered and authenticated.
+ *
+ * Implementations of #MatrixClient must emit
+ * MatrixClient::login-finished when a response arrives.
+ *
+ * If you want to register a different kind of user, use
+ * matrix_api_register_account().
  */
 void
 matrix_client_register_with_password(MatrixClient *client,