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

Merge pull request #186 from quexxon/fix-array-ensure-documentation

Browse Source 
Add missing documentation for array/ensure's growth parameter
This commit is contained in:
Calvin Rose
2019-11-29 22:39:04 -05:00
committed by GitHub
parent 13ef2bd905 9e1c3e0f41
commit bf609445c1
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/core/array.c
View File

@@ -261,11 +261,11 @@ static const JanetReg array_cfuns[] = {
}, },
{ {
"array/ensure", cfun_array_ensure, "array/ensure", cfun_array_ensure,
JDOC("(array/ensure arr capacity)\n\n" JDOC("(array/ensure arr capacity growth)\n\n"
"Ensures that the memory backing the array is large enough for capacity " "Ensures that the memory backing the array is large enough for capacity "
"items. Capacity must be an integer. If the backing capacity is already enough, " "items at the given rate of growth. Capacity and growth must be integers. "
"then this function does nothing. Otherwise, the backing memory will be reallocated " "If the backing capacity is already enough, then this function does nothing. "
"so that there is enough space.") "Otherwise, the backing memory will be reallocated so that there is enough space.")
}, },
{ {
"array/slice", cfun_array_slice, "array/slice", cfun_array_slice,