Is it really necessary for the compiler to spit out a warning about using @doc with private functions?
I don’t want to have to document my functions in two different ways. I want one clean way to present my comments to other developers throughout the codebase, at least at the function head.
I’ve seen others say, on this forum, that private functions aren’t meant to be documented because they are ephemeral. I believe this to be nonsense. Someone else not writing my code has no say in how long I keep my private functions around. I guarantee you even great developers like Jose Valim write private functions. You can probably find them in elixir’s code itself.
Anyways, I know other people have asked the same question and get the same answer, but I think it’s worth drudging up again.