Greetings again.   Hisham wrote:
> but this is a completely different thing: you're referring to
> the repository search, I was referring about the documentation
> material on LuaRocks itself.

True; I saw the word "documentation" just when I happened to
have been through the socket experience myself.
Apologies for being grumpy.

> Your feedback is valuable
Thanks for putting it like that :-)

The three questions I conflated are all documentation issues,
(or "getting useful information to the user" issues, to guarantee
inclusion of repository searches) so they all fit 'docs question',
and so in that sense are not off-topic ...

> > if the Documentation button took you to the LuaSocket doc.
> It would be _super_ helpful. But this is yet another thing, doc
> of modules. There are no standards for documentation in Lua,

I don't think there need to be standards, because however the doc
is put together, it's always easy (and useful) to generate an html
version (and get it hosted somewhere).  So why not allow a line
  documentation = "http://foo.org/bar/doc/index.html";,
presumably next to the homepage= line ?
It doesn't have to be mandatory, but it should be allowed (and
made clickable in rocks.moonscript.org).  It would be helpful to
our users (eg: to check out modules before deciding whether to
install them).  Doc is important in programming and it would be
very easy for us to do it better, system-wide better.

Slightly harder, and more space-hungry, but no change to the
rockspec: if a 'luarocks doc' heuristic sees doc/index.html in the
source then perhaps doc/ could be copied into rocks.moonscript.org
and linked to with a "doc" button ?

Regards,  Peter Billam

http://www.pjb.com.au      p...@pjb.com.au     (03) 6278 9410
"Follow the charge, not the particle."  --  Richard Feynman
 from The Theory of Positrons, Physical Review, 1949


------------------------------------------------------------------------------
Dive into the World of Parallel Programming The Go Parallel Website, sponsored
by Intel and developed in partnership with Slashdot Media, is your hub for all
things parallel software development, from weekly thought leadership blogs to
news, videos, case studies, tutorials and more. Take a look and join the 
conversation now. http://goparallel.sourceforge.net/
_______________________________________________
Luarocks-developers mailing list
Luarocks-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/luarocks-developers

Reply via email to