Document the mix tasks in ex_doc instead

This commit is contained in:
Haelwenn (lanodan) Monnier 2018-11-02 09:32:48 +01:00
commit 8b2541e4e7
No known key found for this signature in database
GPG key ID: D5B7A8E43C997DEE
6 changed files with 32 additions and 21 deletions

View file

@ -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")