Hi Niklas,

This has already been discussed a few times.
https://elixirforum.com/t/proposal-docp-for-private-function-documentation-and-doctests/3732
https://groups.google.com/g/elixir-lang-talk/c/0JKd9XKmIas/m/5927z5BdBgAJ

Kind regrads
Marcus


[email protected] schrieb am Mittwoch, 26. Mai 2021 um 09:13:46 UTC+2:

> 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 [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/elixir-lang-core/9050e3fe-499c-4992-831d-b1490ec99f45n%40googlegroups.com.

Reply via email to