Improve docstring for describe (#1826)

Co-authored-by: sogaiu <983021772@users.noreply.github.com>
This commit is contained in:
sogaiu
2026-08-22 15:00:27 -05:00
committed by GitHub
co-authored by sogaiu
parent f545c91581
commit 92580fd453
+4 -4
View File
@@ -317,10 +317,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 `x`. "
"For recursive data structures, the string returned contains a "
"pointer value from which the identity of `x` "
"can be determined.") {
"Returns a string that is a human-readable description of "
"`x`. For indexed, dictionary, fiber, pointer, and some "
"abstract types, the string returned contains a pointer "
"value from which the identity of `x` can be determined.") {
JanetBuffer *b = janet_buffer(0);
for (int32_t i = 0; i < argc; ++i)
janet_description_b(b, argv[i]);