diff options
author | Haelwenn (lanodan) Monnier <contact@hacktivis.me> | 2018-11-02 09:32:48 +0100 |
---|---|---|
committer | Haelwenn (lanodan) Monnier <contact@hacktivis.me> | 2018-11-10 13:09:37 +0100 |
commit | 8b2541e4e7fb37f38422bf6c02cc10863a927e61 (patch) | |
tree | 0cffe5e69fad6a02377c1f45b7f3a014da5da222 /lib/mix/tasks/generate_config.ex | |
parent | e1814bb322dda732143fdb0cb60dbce82fe433da (diff) | |
download | pleroma-8b2541e4e7fb37f38422bf6c02cc10863a927e61.tar.gz pleroma-8b2541e4e7fb37f38422bf6c02cc10863a927e61.zip |
Document the mix tasks in ex_doc instead
Diffstat (limited to 'lib/mix/tasks/generate_config.ex')
-rw-r--r-- | lib/mix/tasks/generate_config.ex | 10 |
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") |