azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve docs wording of zip function

Browse Source
This commit is contained in:
Ilya Gorbunov
2018-04-20 02:44:48 +03:00
parent 0eae27e03f
commit 501d969a38
5 changed files with 175 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/common/src/generated/_Collections.kt
+10 -4
View File
@@ -2085,7 +2085,8 @@ public fun <T, R> Iterable<T>.windowed(size: Int, step: Int = 1, partialWindows:
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -2094,7 +2095,9 @@ public infix fun <T, R> Iterable<T>.zip(other: Array<out R>): List<Pair<T, R>> {
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` collection and the [other] array with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -2110,7 +2113,8 @@ public inline fun <T, R, V> Iterable<T>.zip(other: Array<out R>, transform: (a:
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] collection with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -2119,7 +2123,9 @@ public infix fun <T, R> Iterable<T>.zip(other: Iterable<R>): List<Pair<T, R>> {
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` collection and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/