mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2024-12-27 00:40:26 +00:00
Code Issues 1 Releases Wiki Activity

Merge pull request #583 from sogaiu/tweak-debug-docs

Browse Source 
Tweak debug/stack docs
This commit is contained in:
Calvin Rose 2021-01-13 21:41:26 -06:00 committed by GitHub
commit dd7342a6cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/core/debug.c
View File

@ -362,18 +362,18 @@ static const JanetReg debug_cfuns[] = {
"debug/stack", cfun_debug_stack, "debug/stack", cfun_debug_stack,
JDOC("(debug/stack fib)\n\n" JDOC("(debug/stack fib)\n\n"
"Gets information about the stack as an array of tables. Each table " "Gets information about the stack as an array of tables. Each table "
"in the array contains information about a stack frame. The top most, current " "in the array contains information about a stack frame. The top-most, current "
"stack frame is the first table in the array, and the bottom most stack frame " "stack frame is the first table in the array, and the bottom-most stack frame "
"is the last value. Each stack frame contains some of the following attributes:\n\n" "is the last value. Each stack frame contains some of the following attributes:\n\n"
"\t:c - true if the stack frame is a c function invocation\n" "* :c - true if the stack frame is a c function invocation\n\n"
"\t:column - the current source column of the stack frame\n" "* :column - the current source column of the stack frame\n\n"
"\t:function - the function that the stack frame represents\n" "* :function - the function that the stack frame represents\n\n"
"\t:line - the current source line of the stack frame\n" "* :line - the current source line of the stack frame\n\n"
"\t:name - the human friendly name of the function\n" "* :name - the human-friendly name of the function\n\n"
"\t:pc - integer indicating the location of the program counter\n" "* :pc - integer indicating the location of the program counter\n\n"
"\t:source - string with the file path or other identifier for the source code\n" "* :source - string with the file path or other identifier for the source code\n\n"
"\t:slots - array of all values in each slot\n" "* :slots - array of all values in each slot\n\n"
"\t:tail - boolean indicating a tail call") "* :tail - boolean indicating a tail call")
}, },
{ {
"debug/stacktrace", cfun_debug_stacktrace, "debug/stacktrace", cfun_debug_stacktrace,