blakedietz.me

Elixir learnings - 2020 Week 3

January 19, 2020

Elixir

Documentation

You can’t use @doc on private functions

Interestingly you can’t use doc for private functions. I understand the argument that documentation shouldn’t be generated for private functions, but it is a little surprising that you have to use multiline comments instead of doc strings to document them.

Sources

  1. Documenting private functions

Blake Dietz

Written by Blake Dietz who lives and works in Boise, ID and loves tinkering in his spare time. Follow him on twitter