On 11/11/2014 10:46 PM, David Roundy wrote:
The biggest thing is that the documentation doesn't answer the
question that is the subject of this email thread: why would one want
to use lua?
I wrote the documentation thinking of an audience that is already
familiar with Tup and Lua, but wanting to know how to integrate the
two. Thank you though, I now realize that there are a lot more
perspectives that need to be considered.
I think right now the organization is probably confusing things. Perhaps
a documentation top-page, giving an introduction to the two parsers and
a brief summary of the differences? And then having all the specific
parser documentation as subpages (rather than 4 top-level documentation
pages)? If I can scrounge up some time, I may take a crack at it myself.
It also doesn't show up in the manual at all, it shows up in a
separate section entitled "Lua parser." That section seems to assume
that we already know the lua language, and thus appears to be intended
for "other people" than an ordinary person wanting to know how to use
tup. It contains no introduction to the lua language, and defines
things in terms of how tup differs from "standard lua." It has a
listing of functions with little explanation of why you would use the,
and it turns out to not be a complete listing anyhow. e.g. there is
apparently a run-script function.
The Lua parser page was intended to be mostly reference (assuming Tup
familiarity), hence the list of functions. I still think a reference
page is useful, but maybe with the addition of more documentation.
An guide to the Lua language is probably out of the scope of the Tup
documentation, but do you think a sentence providing context and
directing readers to the Programming In Lua book might help?
In the meantime, thank you for taking the time to write out suggestions
for the documentation! Next time I work on it I'll see what I can do to
make it more accessible.
--
--
tup-users mailing list
email: [email protected]
unsubscribe: [email protected]
options: http://groups.google.com/group/tup-users?hl=en
---
You received this message because you are subscribed to the Google Groups "tup-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
