mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2025-10-31 07:33:01 +00:00
Code Issues 1 Releases Wiki Activity

tuple.c docstrings

Browse Source 
Added some backticks around code in docstrings to distinguish them from prose.
This commit is contained in:
John Gabriele
2022-04-17 21:26:53 -04:00
committed by GitHub
parent 9986aab326
commit 690b98bff9
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/core/tuple.c
View File

@@ -65,12 +65,12 @@ JANET_CORE_FN(cfun_tuple_brackets,
JANET_CORE_FN(cfun_tuple_slice, JANET_CORE_FN(cfun_tuple_slice,
"(tuple/slice arrtup [,start=0 [,end=(length arrtup)]])", "(tuple/slice arrtup [,start=0 [,end=(length arrtup)]])",
"Take a sub sequence of an array or tuple from index start " "Take a sub-sequence of an array or tuple from index `start` "
"inclusive to index end exclusive. If start or end are not provided, " "inclusive to index `end` exclusive. If `start` or `end` are not provided, "
"they default to 0 and the length of arrtup respectively. " "they default to 0 and the length of `arrtup`, respectively. "
"'start' and 'end' can also be negative to indicate indexing " "`start` and `end` can also be negative to indicate indexing "
"from the end of the input. Note that index -1 is synonymous with " "from the end of the input. Note that index -1 is synonymous with "
"index '(length arrtup)' to allow a full negative slice range. " "index `(length arrtup)` to allow a full negative slice range. "
"Returns the new tuple.") { "Returns the new tuple.") {
JanetView view = janet_getindexed(argv, 0); JanetView view = janet_getindexed(argv, 0);
JanetRange range = janet_getslice(argc, argv); JanetRange range = janet_getslice(argc, argv);
@@ -96,7 +96,7 @@ JANET_CORE_FN(cfun_tuple_type,
JANET_CORE_FN(cfun_tuple_sourcemap, JANET_CORE_FN(cfun_tuple_sourcemap,
"(tuple/sourcemap tup)", "(tuple/sourcemap tup)",
"Returns the sourcemap metadata attached to a tuple, " "Returns the sourcemap metadata attached to a tuple, "
" which is another tuple (line, column).") { "which is another tuple (line, column).") {
janet_fixarity(argc, 1); janet_fixarity(argc, 1);
const Janet *tup = janet_gettuple(argv, 0); const Janet *tup = janet_gettuple(argv, 0);
Janet contents[2]; Janet contents[2];