c050739f41
* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
27 KiB
27 KiB
title, excerpt, layout
| title | excerpt | layout |
|---|---|---|
| pop | Remove the last element from an array. | manual |
Remove the last element from an array.
Returns a new array with the last element removed.
pop(array: [[[KclValue](/docs/kcl/types/KclValue)]](/docs/kcl/types/[KclValue](/docs/kcl/types/KclValue))): [KclValue](/docs/kcl/types/KclValue)
Arguments
| Name | Type | Description | Required |
|---|---|---|---|
array |
[KclValue] |
The array to pop from. Must not be empty. | Yes |
Returns
KclValue - Any KCL value.
Examples
arr = [1, 2, 3, 4]
new_arr = pop(arr)
assert(
new_arr[0],
isEqualTo = 1,
tolerance = 0.00001,
error = "1 is the first element of the array",
)
assert(
new_arr[1],
isEqualTo = 2,
tolerance = 0.00001,
error = "2 is the second element of the array",
)
assert(
new_arr[2],
isEqualTo = 3,
tolerance = 0.00001,
error = "3 is the third element of the array",
)