summaryrefslogtreecommitdiff
path: root/lib/mix/tasks/relay_unfollow.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/relay_unfollow.ex
parentd1a7a9fd24403600851cb541a2021d32b7cc8fc5 (diff)
downloadpleroma-64c0289893e870cf3f5525fdffb6b25ab3cc2f25.tar.gz
pleroma-64c0289893e870cf3f5525fdffb6b25ab3cc2f25.zip
lib/mix/tasks: Add remaining documentation for mix tasks
Diffstat (limited to 'lib/mix/tasks/relay_unfollow.ex')
-rw-r--r--lib/mix/tasks/relay_unfollow.ex8
1 files changed, 7 insertions, 1 deletions
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")