diff options
Diffstat (limited to 'lib/mix/tasks')
| -rw-r--r-- | lib/mix/tasks/generate_password_reset.ex | 8 | ||||
| -rw-r--r-- | lib/mix/tasks/reactivate_user.ex | 8 | ||||
| -rw-r--r-- | lib/mix/tasks/relay_follow.ex | 7 | ||||
| -rw-r--r-- | lib/mix/tasks/relay_unfollow.ex | 8 | ||||
| -rw-r--r-- | lib/mix/tasks/unsubscribe_user.ex | 9 | 
5 files changed, 36 insertions, 4 deletions
| diff --git a/lib/mix/tasks/generate_password_reset.ex b/lib/mix/tasks/generate_password_reset.ex index 6bf640150..e581e2e11 100644 --- a/lib/mix/tasks/generate_password_reset.ex +++ b/lib/mix/tasks/generate_password_reset.ex @@ -2,7 +2,13 @@ defmodule Mix.Tasks.GeneratePasswordReset do    use Mix.Task    alias Pleroma.User -  @shortdoc "Generate password reset link for user" +  @doc """ +  Generate password reset link for user + +  Usage: ``mix generate_password_reset <nickname>`` + +  Example: ``mix generate_password_reset lain`` +  """    def run([nickname]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/reactivate_user.ex b/lib/mix/tasks/reactivate_user.ex index 40bd068ea..41e4cbbec 100644 --- a/lib/mix/tasks/reactivate_user.ex +++ b/lib/mix/tasks/reactivate_user.ex @@ -2,7 +2,13 @@ defmodule Mix.Tasks.ReactivateUser do    use Mix.Task    alias Pleroma.User -  @shortdoc "Reactivate a user" +  @doc """ +  Reactivate a user + +  Usage: ``mix reactivate_user <nickname>`` + +  Example: ``mix reactivate_user lain`` +  """    def run([nickname]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/relay_follow.ex b/lib/mix/tasks/relay_follow.ex index ac6f20924..7428ec6ef 100644 --- a/lib/mix/tasks/relay_follow.ex +++ b/lib/mix/tasks/relay_follow.ex @@ -4,6 +4,13 @@ defmodule Mix.Tasks.RelayFollow do    alias Pleroma.Web.ActivityPub.Relay    @shortdoc "Follows a remote relay" +  @doc """ +  Follows a remote relay + +  Usage: ``mix relay_follow <relay_url>`` + +  Example: ``mix relay_follow https://example.org/relay`` +  """    def run([target]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/relay_unfollow.ex b/lib/mix/tasks/relay_unfollow.ex index 4621ace83..cb13a0729 100644 --- a/lib/mix/tasks/relay_unfollow.ex +++ b/lib/mix/tasks/relay_unfollow.ex @@ -3,7 +3,13 @@ defmodule Mix.Tasks.RelayUnfollow do    require Logger    alias Pleroma.Web.ActivityPub.Relay -  @shortdoc "Follows a remote relay" +  @doc """ +  Unfollows a remote relay + +  Usage: ``mix relay_follow <relay_url>`` + +  Example: ``mix relay_follow https://example.org/relay`` +  """    def run([target]) do      Mix.Task.run("app.start") 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") | 
