This module provides small formating for when you want to display your docs.

All functions intended for formating can be supplied with a string, which allows you to use function names, help and such. The default format is ":f - :h

• :f

Inserts the name function of the function

• :h

Inserts the documentation for the function

• :a

Aligns all documentations up to this point. This only works with functions that format multiple functions.

Example output

Ecbolic.Pretty.format([:hello, :long_function_name], ":f:a - :h")
#=> 
"hello              - returns `world`",
"long_function_name - Long description"