summaryrefslogtreecommitdiff
path: root/lib/mix/tasks/generate_config.ex
diff options
context:
space:
mode:
authorkaniini <nenolod@gmail.com>2018-11-10 12:25:08 +0000
committerkaniini <nenolod@gmail.com>2018-11-10 12:25:08 +0000
commit9cdbac6843db7bc5a3a69bc14d9368d5f9d7b4e6 (patch)
tree632751c00db41a4cdc2027279257a0fca8950452 /lib/mix/tasks/generate_config.ex
parentc9c1f9dee2fe12fe55703255497f4a14eb0d4e13 (diff)
parent5ecb5629f6714cf20df3ac28eef585822fb2ea45 (diff)
downloadpleroma-9cdbac6843db7bc5a3a69bc14d9368d5f9d7b4e6.tar.gz
pleroma-9cdbac6843db7bc5a3a69bc14d9368d5f9d7b4e6.zip
Merge branch 'feature/documentation' into 'develop'
Add ex_doc documentation to Pleroma See merge request pleroma/pleroma!416
Diffstat (limited to 'lib/mix/tasks/generate_config.ex')
-rw-r--r--lib/mix/tasks/generate_config.ex10
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/mix/tasks/generate_config.ex b/lib/mix/tasks/generate_config.ex
index 70a110561..e3cbbf131 100644
--- a/lib/mix/tasks/generate_config.ex
+++ b/lib/mix/tasks/generate_config.ex
@@ -1,7 +1,15 @@
defmodule Mix.Tasks.GenerateConfig do
use Mix.Task
- @shortdoc "Generates a new config"
+ @moduledoc """
+ Generate a new config
+
+ ## Usage
+ ``mix generate_config``
+
+ This mix task is interactive, and will overwrite the config present at ``config/generated_config.exs``.
+ """
+
def run(_) do
IO.puts("Answer a few questions to generate a new config\n")
IO.puts("--- THIS WILL OVERWRITE YOUR config/generated_config.exs! ---\n")