Improve docstring for table/to-struct (#1831)

Co-authored-by: sogaiu <983021772@users.noreply.github.com>
This commit is contained in:
sogaiu
2026-08-26 17:14:45 -05:00
committed by GitHub
co-authored by sogaiu
parent cea6dd2261
commit fbd313976c
+5 -1
View File
@@ -384,7 +384,11 @@ JANET_CORE_FN(cfun_table_setproto,
JANET_CORE_FN(cfun_table_tostruct,
"(table/to-struct tab &opt proto)",
"Convert a table to a struct. Returns a new struct.") {
"Create and return a struct based on a table `tab`. "
"If given, the optional argument `proto` specifies "
"a struct to be used as the newly created struct's "
"prototype. Note that if `proto` is not specified, "
"the newly created struct will not have a prototype.") {
janet_arity(argc, 1, 2);
JanetTable *t = janet_gettable(argv, 0);
JanetStruct proto = janet_optstruct(argv, argc, 1, NULL);