1
0
mirror of https://github.com/janet-lang/janet synced 2024-12-01 12:29:54 +00:00

Add missing documentation for array/ensure's growth parameter

This commit is contained in:
Will Clardy 2019-11-28 23:16:32 -05:00
parent 967a8b5a70
commit 9e1c3e0f41
No known key found for this signature in database
GPG Key ID: 4189A2939BC513E6

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,