[erlang-questions] Erlang documentation -- a modest proposal

Lloyd R. Prentice <>
Fri Sep 23 16:31:27 CEST 2016


> My tentative currently looks similar to this for "man cowboy:start_clear": 
> https://gist.github.com/essen/3affa1c8e7805a7dc867156b03c1854f - in HTML/PDF 
>form it would of course have syntax highlighting, proper links and so on.

Bravo! 

I believe I would be six months further along with my current project if Erlang docs followed this format.

Yes, it would be an overwhelming task to bring current docs up to this standard. But---

A number of years ago a professional writer was under contract to write a book about birds. She was utterly overwhelmed by scope of the task. When she complained to a friend, her friend advised, "One bird at a time."

Best to all,

Lloyd


Sent from my iPad

> On Sep 23, 2016, at 5:17 AM, Loïc Hoguin <> wrote:
> 
> FYI I am currently working on improving the Cowboy function reference. My tentative currently looks similar to this for "man cowboy:start_clear": https://gist.github.com/essen/3affa1c8e7805a7dc867156b03c1854f - in HTML/PDF form it would of course have syntax highlighting, proper links and so on.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20160923/a043d2d9/attachment.html>


More information about the erlang-questions mailing list