如何对mix.exs中定义的别名进行描述？

Question

当我在 mix.exs 和运行 mix help 中定义别名时，它只显示其描述为“在 mix.exs 中定义的别名”。

假设，例如，我有这个 mix.exs:

  defp aliases do
    [
      play: "run --no-halt"
    ]
  end

然后，mix help命令显示任务列表如下：

...
mix local.rebar       # Installs Rebar locally
mix new               # Creates a new Elixir project
mix play              # Alias defined in mix.exs
mix profile.cprof     # Profiles the given file or expression with cprof
mix profile.eprof     # Profiles the given file or expression with eprof
...

如何描述 play 任务？

Answer 1

mix help 的输出来自自定义混合任务@shortdoc attribute

defmodule Mix.Tasks.Play do
  use Mix.Task
  @shortdoc "run with --no-halt"

  @impl Mix.Task
  def run(_) do
    Mix.Task.run("run", ["--no-halt"])
  end
end

mix help | grep "mix play"
mix play                  # run with --no-halt

我认为没有办法为别名添加帮助文档。

如何对mix.exs中定义的别名进行描述？

How to give a description to an alias defined in mix.exs?

elixir-mix

elixir