lua-users home
lua-l archive

[Date Prev][Date Next][Thread Prev][Thread Next] [Date Index] [Thread Index]


On Tue, Mar 29, 2011 at 5:42 PM, steve donovan <steve.j.donovan@gmail.com> wrote:
On Tue, Mar 29, 2011 at 3:44 AM, Matthew Frazier
<leafstormrush@gmail.com> wrote:
>  Being able to
> write docs in Markdown would be better.

Oh yes, having HTML tags in comments is ugly and very 20th century.

> - Its reliance on API documentation rather than narrative documentation.
> This makes it hard to explain complex topics.

This is a hard one, because finding a good organization for
documentation is not easy; the tool should provide suitable templates?

If Markdown was allowed, then long module preambles would not be such
a pain to write.

steve d.

http://fitzgen.github.com/pocco/
This is really cool for narrative style documentation.