[erlang-questions] dialyzer output help

Garrett Smith <>
Mon Aug 10 15:02:48 CEST 2015


On Mon, Aug 10, 2015 at 7:56 AM, Loïc Hoguin <> wrote:
> On 08/10/2015 02:51 PM, Garrett Smith wrote:
>>
>> On Mon, Aug 10, 2015 at 7:47 AM, Loïc Hoguin <> wrote:
>>>
>>> Separate the documentation from the code
>>
>> For documenting modules along the lines of erlang.org's reference
>> material [1] what do you do?
>>
>> [1] E.g. http://erlang.org/doc/man/lists.html
>
> This is what *they* do:
>
>   https://github.com/erlang/otp/blob/maint/lib/stdlib/doc/src/lists.xml

XML, for when life is going a little too well.

> What I do is similar, except using Asciidoc:
>
>   https://github.com/ninenines/gun/blob/master/doc/src/manual/gun.asciidoc
>
> (Tried a few formats over the years, settled on that one recently, don't
> think I'll switch again. :-)

This is great - I'll use this!


More information about the erlang-questions mailing list