1
0
mirror of https://github.com/janet-lang/janet synced 2024-11-25 01:37:19 +00:00

Update docs for describe

closes #524
This commit is contained in:
John Gabriele 2022-02-23 00:36:24 -05:00 committed by GitHub
parent 6f645c4cb7
commit dbd1316d1e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -339,7 +339,10 @@ JANET_CORE_FN(janet_core_native,
JANET_CORE_FN(janet_core_describe,
"(describe x)",
"Returns a string that is a human-readable description of a value x.") {
"Returns a string that is a human-readable description of `x`. "
"For recursive data structures, the string returned contains a "
"more or less unique pointer value from which the identity of `x` "
"could be determined.") {
JanetBuffer *b = janet_buffer(0);
for (int32_t i = 0; i < argc; ++i)
janet_description_b(b, argv[i]);