aboutsummaryrefslogtreecommitdiff
path: root/lib/mix/tasks/rm_user.ex
diff options
context:
space:
mode:
authorkaniini <nenolod@gmail.com>2018-11-10 12:25:08 +0000
committerkaniini <nenolod@gmail.com>2018-11-10 12:25:08 +0000
commit9cdbac6843db7bc5a3a69bc14d9368d5f9d7b4e6 (patch)
tree632751c00db41a4cdc2027279257a0fca8950452 /lib/mix/tasks/rm_user.ex
parentc9c1f9dee2fe12fe55703255497f4a14eb0d4e13 (diff)
parent5ecb5629f6714cf20df3ac28eef585822fb2ea45 (diff)
downloadpleroma-9cdbac6843db7bc5a3a69bc14d9368d5f9d7b4e6.tar.gz
Merge branch 'feature/documentation' into 'develop'
Add ex_doc documentation to Pleroma See merge request pleroma/pleroma!416
Diffstat (limited to 'lib/mix/tasks/rm_user.ex')
-rw-r--r--lib/mix/tasks/rm_user.ex8
1 files changed, 7 insertions, 1 deletions
diff --git a/lib/mix/tasks/rm_user.ex b/lib/mix/tasks/rm_user.ex
index b7c922d6c..50463046c 100644
--- a/lib/mix/tasks/rm_user.ex
+++ b/lib/mix/tasks/rm_user.ex
@@ -2,7 +2,13 @@ defmodule Mix.Tasks.RmUser do
use Mix.Task
alias Pleroma.User
- @shortdoc "Permanently delete a user"
+ @moduledoc """
+ Permanently deletes a user
+
+ Usage: ``mix rm_user [nickname]``
+
+ Example: ``mix rm_user lain``
+ """
def run([nickname]) do
Mix.Task.run("app.start")