On Thu, Apr 14, 2011 at 9:41 AM, Jim Whitehead II <[email protected]> wrote:
> Online docs beat it, but we are not always online. Although Lua docs are not
> comprehensive or standardized, having the 'godoc' command for all of my Go
> code is way more useful than I thought it would be. I consider this an
> opportunity, not a problem.

Yes, I agree with Alexander that something like

gnome-open $(luarocks --rock-dir penlight)/docs/index.html

is way too clunky and fragile. So it would be good to think about a LR
subcommand 'doc' which does the above in a platform-independent way
and uses a few heuristics (doc or docs? locale-specific directory?
etc)  There are no standards, but that is indeed an opportunity.

Talking of godoc, Norman Clarke and myself have been playing with
ldoc, which does something rather similar (when it's not pretending to
be LuaDoc)  That is, looks up the module on the path and extracts
LuaDoc-style annotations from it. Currently the output is ugly, but we
have hopes.

BTW, it is almost possible for LuaRocks to install extra LuaRocks
commands. Not quite, since the command needs to be registered, but
this is a mere technical problem ;)  This would allow new
functionality to be deployed without interfering with the LR release
cycle.

steve d.

_______________________________________________
Luarocks-developers mailing list
[email protected]
http://lists.luaforge.net/cgi-bin/mailman/listinfo/luarocks-developers

Reply via email to