1
0
mirror of https://github.com/janet-lang/janet synced 2024-12-28 09:20:26 +00:00

Tweak disasm docs

This commit is contained in:
sogaiu 2021-01-13 22:27:03 +09:00
parent 4f2d1cdc00
commit 068bd33afb

View File

@ -992,18 +992,18 @@ static const JanetReg asm_cfuns[] = {
"func must be a function, not a c function. Will throw on error on a badly\n" "func must be a function, not a c function. Will throw on error on a badly\n"
"typed argument. If given a field name, will only return that part of the function assembly.\n" "typed argument. If given a field name, will only return that part of the function assembly.\n"
"Possible fields are:\n\n" "Possible fields are:\n\n"
"\t:arity - number of required and optional arguments.\n" "* :arity - number of required and optional arguments.\n\n"
"\t:min-arity - minimum number of arguments function can be called with.\n" "* :min-arity - minimum number of arguments function can be called with.\n\n"
"\t:max-arity - maximum number of arguments function can be called with.\n" "* :max-arity - maximum number of arguments function can be called with.\n\n"
"\t:vararg - true if function can take a variable number of arguments.\n" "* :vararg - true if function can take a variable number of arguments.\n\n"
"\t:bytecode - array of parsed bytecode instructions. Each instruction is a tuple.\n" "* :bytecode - array of parsed bytecode instructions. Each instruction is a tuple.\n\n"
"\t:source - name of source file that this function was compiled from.\n" "* :source - name of source file that this function was compiled from.\n\n"
"\t:name - name of function.\n" "* :name - name of function.\n\n"
"\t:slotcount - how many virtual registers, or slots, this function uses. Corresponds to stack space used by function.\n" "* :slotcount - how many virtual registers, or slots, this function uses. Corresponds to stack space used by function.\n\n"
"\t:constants - an array of constants referenced by this function.\n" "* :constants - an array of constants referenced by this function.\n\n"
"\t:sourcemap - a mapping of each bytecode instruction to a line and column in the source file.\n" "* :sourcemap - a mapping of each bytecode instruction to a line and column in the source file.\n\n"
"\t:environments - an internal mapping of which enclosing functions are referenced for bindings.\n" "* :environments - an internal mapping of which enclosing functions are referenced for bindings.\n\n"
"\t:defs - other function definitions that this function may instantiate.\n") "* :defs - other function definitions that this function may instantiate.\n")
}, },
{NULL, NULL, NULL} {NULL, NULL, NULL}
}; };