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

Mix tasks: improve uploads.ex moduledoc

See merge request pleroma/pleroma!528

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 """
-   Manages uploads
-   ## Migrate uploads from local to remote storage
 
+  @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")