seqlua
changeset 3:22ec338adc20
Documented seqlua_iterinit's extra element on stack in README
author | jbe |
---|---|
date | Wed Aug 20 01:22:45 2014 +0200 (2014-08-20) |
parents | 0617c8368132 |
children | 44eddb9cea1e |
files | README |
line diff
1.1 --- a/README Wed Aug 20 01:14:37 2014 +0200 1.2 +++ b/README Wed Aug 20 01:22:45 2014 +0200 1.3 @@ -133,6 +133,10 @@ 1.4 1.5 printcsv{"a", "b", "c"} -- prints: a,b,c 1.6 1.7 +NOTE: ``seqlua_iterinit`` will store one extra element on the stack during 1.8 +iteration. When ``seqlua_iternext`` returns 0, this extra element is popped 1.9 +from the stack automatically. 1.10 + 1.11 Additionally, ``seqlualib`` includes a function ``seqlua_iterclosure(L, idx)``, 1.12 which converts a table at a given stack index into a function closure (stored 1.13 on the same stack index) that iterates over the elements of the table. If the