summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLaurenz Stampfl <47084093+LaurenzV@users.noreply.github.com>2023-04-25 11:22:20 +0200
committerGitHub <noreply@github.com>2023-04-25 11:22:20 +0200
commitf38989358e768ebe17c5f191cf9026d513e6f6b7 (patch)
tree1cc6f1637a824ab6471e7ca9550d44b4266d6cf4 /docs
parentd5d98b67a83944d72a5c0f8e8e2f43aeee667122 (diff)
Add a zip method to arrays (#947)
Diffstat (limited to 'docs')
-rw-r--r--docs/src/reference/types.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/src/reference/types.md b/docs/src/reference/types.md
index 24756422..1bae6b75 100644
--- a/docs/src/reference/types.md
+++ b/docs/src/reference/types.md
@@ -620,6 +620,16 @@ for loop.
- returns: array
+### zip()
+Zips the array with another array. If the two arrays are of unequal length, it
+will only zip up until the last element of the smaller array and the remaining
+elements will be ignored. The return value is an array where each element is yet
+another array of size 2.
+
+- other: array (positional, required)
+ The other array which should be zipped with the current one.
+- returns: array
+
### fold()
Folds all items into a single value using an accumulator function.