I think it would be great to have the possibility to write documentations 
for private functions similar to writing documentation for public 
functions. Maybe something like this.

@docp """
Increase with one
"""
defp convert(x) do
  x + 1
end

This tag will not generate "real" documentation but aims to make the code 
more readable "in the editor". And to help other developers understand the 
private function.

By using @docp, it will look very simlar to a public function with a @doc 
tag.

Kind regards
Niklas

-- 
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/f078c2ca-e6b7-405a-94c2-c931ae053d97n%40googlegroups.com.

Reply via email to