Proposal: Introduce help catalogs

Thanks for the input @voughtdq. It is really nice to hear that Elixir warnings have been helpful. I have explained in previous replies why long warnings should need to be opt-in. Can you please see the previous comments and reply accordingly? In a nutshell, once the catalog is present, the warnings will tend to get much longer.

How is it one more thing to learn? The only time they will have to care about it, we will explicitly tell them which command to run. It is not like they have to memorize it. :slight_smile:

In your example, such as div_doc, when would div_doc ever be called with zero? What is passing those inputs in? How would ExDoc know how to generate documentation from now on?

I would say that unifying them is welcome. We recently got rid of s exactly because of this. But, as you said, I don’t know how to do it without adding ambiguity. Note that the arguments of h have to be valid Elixir syntax and c:GenServer isn’t (it is, but it emits warnings).

1 Like