From a9ac10e876da1bfde0b7c3bbc4039745e4e79368 Mon Sep 17 00:00:00 2001
From: Badlop <badlop@process-one.net>
Date: Thu, 13 Jan 2022 19:28:50 +0100
Subject: Document that 'unregister' command deletes data associated with the
 account

---
 src/ejabberd_admin.erl | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src/ejabberd_admin.erl')

diff --git a/src/ejabberd_admin.erl b/src/ejabberd_admin.erl
index 14305e84..9e72c7b3 100644
--- a/src/ejabberd_admin.erl
+++ b/src/ejabberd_admin.erl
@@ -181,6 +181,8 @@ get_commands_spec() ->
 			result = {res, restuple}},
      #ejabberd_commands{name = unregister, tags = [accounts],
 			desc = "Unregister a user",
+			longdesc = "This deletes the authentication and all the "
+                        "data associated to the account (roster, vcard...).",
                         policy = admin,
 			module = ?MODULE, function = unregister,
 			args_desc = ["Username", "Local vhost served by ejabberd"],
-- 
cgit v1.2.3