Mix tasks: improve uploads.ex moduledoc
authorRin Toshaka <rinpatch@sdf.org>
Sun, 9 Dec 2018 19:17:35 +0000 (20:17 +0100)
committerRin Toshaka <rinpatch@sdf.org>
Sun, 9 Dec 2018 19:17:35 +0000 (20:17 +0100)
lib/mix/tasks/pleroma/uploads.ex

index 0742ab378bfc7689bdeeee73f64a865dcc2d1d3e..d934bd6dc4b26e0320af5ba3c60cb88196050ff2 100644 (file)
@@ -6,11 +6,17 @@ defmodule Mix.Tasks.Pleroma.Uploads do
   require Logger
 
   @log_every 50
-  @shortdoc "Migrate uploads from local to remote storage"
-  @longdoc """
-   Manages uploads
+  @shortdoc "Manages uploads"
+  @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