pleroma

commit: 8aa646ca31f44c6dc0ad688a6007576be95966e0
parent: 729321ad20c7c4996b10ac86362a49f6d4cf0841
Author: lambda <pleromagit@rogerbraun.net>
Date:   Mon, 10 Dec 2018 19:06:39 +0000

Merge branch 'fix/mix-task-uploads-moduledoc' into 'develop'

Mix tasks: improve uploads.ex moduledoc

See merge request pleroma/pleroma!528
Diffstat:
M
lib/mix/tasks/pleroma/uploads.ex
11
+++++++++--

1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/lib/mix/tasks/pleroma/uploads.ex b/lib/mix/tasks/pleroma/uploads.ex
@@ -5,11 +5,18 @@ defmodule Mix.Tasks.Pleroma.Uploads do
   require Logger
 
   @log_every 50
-  @shortdoc "Migrate uploads from local to remote storage"
-  @doc """
+
+  @shortdoc "Migrates uploads from local to remote storage"
+  @moduledoc """
    Manages uploads
+
    ## Migrate uploads from local to remote storage
+       mix pleroma.uploads migrate_local TARGET_UPLOADER [OPTIONS...]
+   Options:
+   - `--delete` - delete local uploads after migrating them to the target uploader
+
 
+   A list of avalible uploaders can be seen in config.exs
   """
   def run(["migrate_local", target_uploader | args]) do
     delete? = Enum.member?(args, "--delete")