lua-users home
lua-l archive

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


On Fri, Feb 17, 2012 at 2:33 AM, Jay Carlson <nop@nop.com> wrote:
> Well. sorta. A lot of the tools in microlight are useful in a *lot* of
> situations, but it is not immediately obvious what all the situations
> all are.

Oh yes. It does require more than Axel's 'single line of English' to
explain functions which are meant as building blocks. You need to
present a few small buildings to show how they fit together.  So more
English and code examples!

If people _need_ to look at a function definition, then by definition
it's not sufficiently documented.  Some of these functions seem
deceptively simple, like split, which has some interesting edge-cases.
And those edge-cases involve decisions that need themselves to be
documented.

Tim made some good points about functions that need not be invented;
one of them was that they should not have a 'trivial definition'. Fair
enough, but when they start to get copy-pasted everywhere then the red
flag rises.  And some things aren't as trivial as they look ;)

steve d.