Merge branch 'add-MIX_ENV-to-systemd-example' into 'develop'
[akkoma] / lib / mix / tasks / deactivate_user.ex
index 96b3db6e4110c4662d86df105fde89dae53690f5..e71ed1ec05caa7ca5dc212ab6a718077e6f2284c 100644 (file)
@@ -2,7 +2,13 @@ defmodule Mix.Tasks.DeactivateUser do
   use Mix.Task
   alias Pleroma.User
 
-  @shortdoc "Toggle deactivation status for a user"
+  @moduledoc """
+  Deactivates a user (local or remote)
+
+  Usage: ``mix deactivate_user <nickname>``
+
+  Example: ``mix deactivate_user lain``
+  """
   def run([nickname]) do
     Mix.Task.run("app.start")