aboutsummaryrefslogtreecommitdiff
path: root/lib/mix/tasks/unsubscribe_user.ex
diff options
context:
space:
mode:
authorHaelwenn (lanodan) Monnier <contact@hacktivis.me>2018-11-08 15:21:09 +0100
committerHaelwenn (lanodan) Monnier <contact@hacktivis.me>2018-11-10 13:09:38 +0100
commit64c0289893e870cf3f5525fdffb6b25ab3cc2f25 (patch)
treeb4b108cffeb46e1235a8e0d76f349b2d483edcaf /lib/mix/tasks/unsubscribe_user.ex
parentd1a7a9fd24403600851cb541a2021d32b7cc8fc5 (diff)
downloadpleroma-64c0289893e870cf3f5525fdffb6b25ab3cc2f25.tar.gz
lib/mix/tasks: Add remaining documentation for mix tasks
Diffstat (limited to 'lib/mix/tasks/unsubscribe_user.ex')
-rw-r--r--lib/mix/tasks/unsubscribe_user.ex9
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/mix/tasks/unsubscribe_user.ex b/lib/mix/tasks/unsubscribe_user.ex
index bb72634b6..75811374b 100644
--- a/lib/mix/tasks/unsubscribe_user.ex
+++ b/lib/mix/tasks/unsubscribe_user.ex
@@ -3,7 +3,14 @@ defmodule Mix.Tasks.UnsubscribeUser do
alias Pleroma.{User, Repo}
require Logger
- @shortdoc "Unsubscribe all users from a target and then deactivate them"
+ @doc """
+ Deactivate and Unsubscribe local users from a user
+
+ Usage: ``mix unsubscribe_user <nickname>``
+
+ Example: ``mix unsubscribe_user lain``
+ """
+ def run([nickname]) do
def run([nickname]) do
Mix.Task.run("app.start")