Mix.Tasks.Pleroma.Uploads: Fix typo in documentation

[akkoma] / lib / mix / tasks / pleroma / uploads.ex

diff --git a/lib/mix/tasks/pleroma/uploads.ex b/lib/mix/tasks/pleroma/uploads.ex
index c6b8401303406e795cbdc390fd67ff85ce39c6e0..460fa161babd29f17d69cf6acfd1dc584a5076dd 100644 (file)
--- a/lib/mix/tasks/pleroma/uploads.ex
+++ b/lib/mix/tasks/pleroma/uploads.ex
@@ -1,3 +1,7 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2018 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
 defmodule Mix.Tasks.Pleroma.Uploads do
   use Mix.Task
   alias Pleroma.{Upload, Uploaders.Local}
@@ -5,11 +9,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 available uploaders can be seen in config.exs
   """
   def run(["migrate_local", target_uploader | args]) do
     delete? = Enum.member?(args, "--delete")