summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsanine <sanine.not@pm.me>2021-08-26 11:30:22 -0500
committersanine <sanine.not@pm.me>2021-08-26 11:30:22 -0500
commit2526f9e419923fdd871c7065523dcd2cf80cec72 (patch)
tree481c88a934838bf47f50e5fa5941c3a36b9bcd47 /README.md
parent9d4fa04c41ce44ad8bfaa9cce65e2b26d8b642d1 (diff)
add first-pass implementation of hs_parse_overloaded
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 432100b..ad32264 100644
--- a/README.md
+++ b/README.md
@@ -94,7 +94,9 @@ with helpful error messages.
integer that will be filled with the stack index of the argument.
Please note that, due to technical limitations, this function can
-only parse up to 255 arguments.
+only parse up to 255 arguments. This function may mutate any
+preexisting contents of the variables passed to contain the
+arguments.
```c
int some_lua_binding(lua_State *L)
@@ -132,6 +134,9 @@ actually used.
If none of the argument lists match the provided arguments, this
function throws an error.
+This function may mutate preexisting data in the variables passed to
+store arguments.
+
```c
int overloaded_lua_binding(lua_State *L)
{