Before going down this road, I would first like to add "mix help --aliases" and we could show the alias definition (i.e. what it invokes). I think it would already be a massive improvement to the UX. Would you like to give this a try?
On Thu, Nov 2, 2023 at 12:45 PM Panagiotis Nezis <pne...@gmail.com> wrote: > Big projects tend to have multiple aliases. It would be nice, especially > for newcomers, to be able to document the project's aliases. This is > especially useful for aliases expecting CLI arguments. > > An option could be to add an `aliases_docs` project config setting where > you could be able to (optionally) define a shortdoc and (maybe) a detailed > doc for an alias. Something like: > > aliases_docs: [ > lint: [ > shordoc: "lints the project", > doc: """ > Some detailed docs here > """ > ] > ] > > Would be happy to open a PR if you agree with this proposal. > > -- > You received this message because you are subscribed to the Google Groups > "elixir-lang-core" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to elixir-lang-core+unsubscr...@googlegroups.com. > To view this discussion on the web visit > https://groups.google.com/d/msgid/elixir-lang-core/CAPxxbtguAJjSSHxqP6XbpJXbyNAm_dQpXu5ZhzdMiU52eM-4hg%40mail.gmail.com > <https://groups.google.com/d/msgid/elixir-lang-core/CAPxxbtguAJjSSHxqP6XbpJXbyNAm_dQpXu5ZhzdMiU52eM-4hg%40mail.gmail.com?utm_medium=email&utm_source=footer> > . > -- You received this message because you are subscribed to the Google Groups "elixir-lang-core" group. To unsubscribe from this group and stop receiving emails from it, send an email to elixir-lang-core+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/elixir-lang-core/CAGnRm4J_tfyf-Gs5ngg3xjXjawQGfESt%2BRhMwtEhp-rJiD%3DAoA%40mail.gmail.com.
