diff --git a/libraries/stdlib/common/src/generated/_Arrays.kt b/libraries/stdlib/common/src/generated/_Arrays.kt index ec867b725a4..03d569595e4 100644 --- a/libraries/stdlib/common/src/generated/_Arrays.kt +++ b/libraries/stdlib/common/src/generated/_Arrays.kt @@ -12206,7 +12206,8 @@ public inline fun CharArray.partition(predicate: (Char) -> Boolean): Pair Array.zip(other: Array): List> } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12224,7 +12226,8 @@ public infix fun ByteArray.zip(other: Array): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12233,7 +12236,8 @@ public infix fun ShortArray.zip(other: Array): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12242,7 +12246,8 @@ public infix fun IntArray.zip(other: Array): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12251,7 +12256,8 @@ public infix fun LongArray.zip(other: Array): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12260,7 +12266,8 @@ public infix fun FloatArray.zip(other: Array): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12269,7 +12276,8 @@ public infix fun DoubleArray.zip(other: Array): List> } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12278,7 +12286,8 @@ public infix fun BooleanArray.zip(other: Array): List CharArray.zip(other: Array): List> { } /** - * 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` array 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 */ @@ -12301,7 +12312,9 @@ public inline fun Array.zip(other: Array, transform: (a: } /** - * 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` array 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 */ @@ -12315,7 +12328,9 @@ public inline fun ByteArray.zip(other: Array, transform: (a: Byte, } /** - * 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` array 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 */ @@ -12329,7 +12344,9 @@ public inline fun ShortArray.zip(other: Array, transform: (a: Shor } /** - * 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` array 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 */ @@ -12343,7 +12360,9 @@ public inline fun IntArray.zip(other: Array, transform: (a: Int, b } /** - * 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` array 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 */ @@ -12357,7 +12376,9 @@ public inline fun LongArray.zip(other: Array, transform: (a: Long, } /** - * 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` array 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 */ @@ -12371,7 +12392,9 @@ public inline fun FloatArray.zip(other: Array, transform: (a: Floa } /** - * 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` array 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 */ @@ -12385,7 +12408,9 @@ public inline fun DoubleArray.zip(other: Array, transform: (a: Dou } /** - * 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` array 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 */ @@ -12399,7 +12424,9 @@ public inline fun BooleanArray.zip(other: Array, transform: (a: Bo } /** - * 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` array 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 */ @@ -12413,7 +12440,8 @@ public inline fun CharArray.zip(other: Array, transform: (a: Char, } /** - * 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] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12422,7 +12450,8 @@ public infix fun Array.zip(other: Iterable): List> { } /** - * 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] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12431,7 +12460,8 @@ public infix fun ByteArray.zip(other: Iterable): List> { } /** - * 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] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12440,7 +12470,8 @@ public infix fun ShortArray.zip(other: Iterable): List> { } /** - * 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] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12449,7 +12480,8 @@ public infix fun IntArray.zip(other: Iterable): List> { } /** - * 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] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12458,7 +12490,8 @@ public infix fun LongArray.zip(other: Iterable): List> { } /** - * 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] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12467,7 +12500,8 @@ public infix fun FloatArray.zip(other: Iterable): List> { } /** - * 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] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12476,7 +12510,8 @@ public infix fun DoubleArray.zip(other: Iterable): List> } /** - * 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] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12485,7 +12520,8 @@ public infix fun BooleanArray.zip(other: Iterable): List } /** - * 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] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12494,7 +12530,9 @@ public infix fun CharArray.zip(other: Iterable): List> { } /** - * 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` array 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 */ @@ -12510,7 +12548,9 @@ public inline fun Array.zip(other: Iterable, transform: (a: } /** - * 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` array 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 */ @@ -12526,7 +12566,9 @@ public inline fun ByteArray.zip(other: Iterable, transform: (a: Byte, } /** - * 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` array 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 */ @@ -12542,7 +12584,9 @@ public inline fun ShortArray.zip(other: Iterable, transform: (a: Short } /** - * 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` array 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 */ @@ -12558,7 +12602,9 @@ public inline fun IntArray.zip(other: Iterable, transform: (a: Int, b: } /** - * 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` array 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 */ @@ -12574,7 +12620,9 @@ public inline fun LongArray.zip(other: Iterable, transform: (a: Long, } /** - * 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` array 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 */ @@ -12590,7 +12638,9 @@ public inline fun FloatArray.zip(other: Iterable, transform: (a: Float } /** - * 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` array 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 */ @@ -12606,7 +12656,9 @@ public inline fun DoubleArray.zip(other: Iterable, transform: (a: Doub } /** - * 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` array 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 */ @@ -12622,7 +12674,9 @@ public inline fun BooleanArray.zip(other: Iterable, transform: (a: Boo } /** - * 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` array 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 */ @@ -12638,7 +12692,8 @@ public inline fun CharArray.zip(other: Iterable, transform: (a: Char, } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12647,7 +12702,8 @@ public infix fun ByteArray.zip(other: ByteArray): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12656,7 +12712,8 @@ public infix fun ShortArray.zip(other: ShortArray): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12665,7 +12722,8 @@ public infix fun IntArray.zip(other: IntArray): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12674,7 +12732,8 @@ public infix fun LongArray.zip(other: LongArray): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12683,7 +12742,8 @@ public infix fun FloatArray.zip(other: FloatArray): List> { } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12692,7 +12752,8 @@ public infix fun DoubleArray.zip(other: DoubleArray): List> } /** - * 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` array and the [other] array with the same index. + * The returned list has length of the shortest collection. * * @sample samples.collections.Iterables.Operations.zipIterable */ @@ -12701,7 +12762,8 @@ public infix fun BooleanArray.zip(other: BooleanArray): List> { } /** - * 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` array 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 array. * * @sample samples.collections.Iterables.Operations.zipIterableWithTransform */ @@ -12724,7 +12788,9 @@ public inline fun ByteArray.zip(other: ByteArray, transform: (a: Byte, b: By } /** - * 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` array 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 array. * * @sample samples.collections.Iterables.Operations.zipIterableWithTransform */ @@ -12738,7 +12804,9 @@ public inline fun ShortArray.zip(other: ShortArray, transform: (a: Short, b: } /** - * 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` array 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 array. * * @sample samples.collections.Iterables.Operations.zipIterableWithTransform */ @@ -12752,7 +12820,9 @@ public inline fun IntArray.zip(other: IntArray, transform: (a: Int, b: Int) } /** - * 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` array 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 array. * * @sample samples.collections.Iterables.Operations.zipIterableWithTransform */ @@ -12766,7 +12836,9 @@ public inline fun LongArray.zip(other: LongArray, transform: (a: Long, b: Lo } /** - * 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` array 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 array. * * @sample samples.collections.Iterables.Operations.zipIterableWithTransform */ @@ -12780,7 +12852,9 @@ public inline fun FloatArray.zip(other: FloatArray, transform: (a: Float, b: } /** - * 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` array 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 array. * * @sample samples.collections.Iterables.Operations.zipIterableWithTransform */ @@ -12794,7 +12868,9 @@ public inline fun DoubleArray.zip(other: DoubleArray, transform: (a: Double, } /** - * 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` array 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 array. * * @sample samples.collections.Iterables.Operations.zipIterableWithTransform */ @@ -12808,7 +12884,9 @@ public inline fun BooleanArray.zip(other: BooleanArray, transform: (a: Boole } /** - * 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` array 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 array. * * @sample samples.collections.Iterables.Operations.zipIterableWithTransform */ diff --git a/libraries/stdlib/common/src/generated/_Collections.kt b/libraries/stdlib/common/src/generated/_Collections.kt index 2d2aef5b00c..582d0da9552 100644 --- a/libraries/stdlib/common/src/generated/_Collections.kt +++ b/libraries/stdlib/common/src/generated/_Collections.kt @@ -2085,7 +2085,8 @@ public fun Iterable.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 Iterable.zip(other: Array): List> { } /** - * 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 Iterable.zip(other: Array, 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 Iterable.zip(other: Iterable): List> { } /** - * 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 */ diff --git a/libraries/stdlib/common/src/generated/_Sequences.kt b/libraries/stdlib/common/src/generated/_Sequences.kt index f6102a6d319..8d202f4bf06 100644 --- a/libraries/stdlib/common/src/generated/_Sequences.kt +++ b/libraries/stdlib/common/src/generated/_Sequences.kt @@ -1557,8 +1557,8 @@ public fun Sequence.windowed(size: Int, step: Int = 1, partialWindows: } /** - * Returns a sequence of pairs built from elements of both sequences with same indexes. - * Resulting sequence has length of shortest input sequence. + * Returns a sequence of values built from the elements of `this` sequence and the [other] sequence with the same index. + * The resulting sequence ends as soon as the shortest input sequence ends. * * @sample samples.collections.Sequences.Transformations.zip * @@ -1569,7 +1569,9 @@ public infix fun Sequence.zip(other: Sequence): Sequence } /** - * Returns a sequence of values built from elements of both collections with same indexes using provided [transform]. Resulting sequence has length of shortest input sequences. + * Returns a sequence of values built from the elements of `this` sequence and the [other] sequence with the same index + * using the provided [transform] function applied to each pair of elements. + * The resulting sequence ends as soon as the shortest input sequence ends. * * @sample samples.collections.Sequences.Transformations.zipWithTransform * diff --git a/libraries/stdlib/common/src/generated/_Strings.kt b/libraries/stdlib/common/src/generated/_Strings.kt index f2bb25b0dcc..627783d2893 100644 --- a/libraries/stdlib/common/src/generated/_Strings.kt +++ b/libraries/stdlib/common/src/generated/_Strings.kt @@ -1312,7 +1312,8 @@ public fun CharSequence.windowedSequence(size: Int, step: Int = 1, partialWi } /** - * Returns a list of pairs built from characters of both char sequences with same indexes. List has length of shortest char sequence. + * Returns a list of pairs built from the characters of `this` and the [other] char sequences with the same index + * The returned list has length of the shortest char sequence. * * @sample samples.text.Strings.zip */ @@ -1321,7 +1322,9 @@ public infix fun CharSequence.zip(other: CharSequence): List> { } /** - * Returns a list of values built from characters of both char sequences with same indexes using provided [transform]. List has length of shortest char sequence. + * Returns a list of values built from the characters of `this` and the [other] char sequences with the same index + * using the provided [transform] function applied to each pair of characters. + * The returned list has length of the shortest char sequence. * * @sample samples.text.Strings.zipWithTransform */ diff --git a/libraries/tools/kotlin-stdlib-gen/src/templates/Generators.kt b/libraries/tools/kotlin-stdlib-gen/src/templates/Generators.kt index d352a4c3e0a..bb19898982e 100644 --- a/libraries/tools/kotlin-stdlib-gen/src/templates/Generators.kt +++ b/libraries/tools/kotlin-stdlib-gen/src/templates/Generators.kt @@ -1004,7 +1004,9 @@ object Generators : TemplateGroupBase() { } builder { doc { """ - 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` ${f.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 """ @@ -1043,7 +1045,9 @@ object Generators : TemplateGroupBase() { } builder { doc { """ - 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` ${f.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 """ @@ -1082,7 +1086,9 @@ object Generators : TemplateGroupBase() { } builder { doc { """ - 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` array 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 array. @sample samples.collections.Iterables.Operations.zipIterableWithTransform """ @@ -1107,7 +1113,9 @@ object Generators : TemplateGroupBase() { } builder { doc { """ - Returns a sequence of values built from elements of both collections with same indexes using provided [transform]. Resulting sequence has length of shortest input sequences. + Returns a sequence of values built from the elements of `this` sequence and the [other] sequence with the same index + using the provided [transform] function applied to each pair of elements. + The resulting sequence ends as soon as the shortest input sequence ends. @sample samples.collections.Sequences.Transformations.zipWithTransform """ @@ -1128,7 +1136,9 @@ object Generators : TemplateGroupBase() { } builder { doc { """ - Returns a list of values built from characters of both char sequences with same indexes using provided [transform]. List has length of shortest char sequence. + Returns a list of values built from the characters of `this` and the [other] char sequences with the same index + using the provided [transform] function applied to each pair of characters. + The returned list has length of the shortest char sequence. @sample samples.text.Strings.zipWithTransform """ @@ -1156,7 +1166,8 @@ object Generators : TemplateGroupBase() { infix(true) doc { """ - 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] ${f.collection} with the same index. + The returned list has length of the shortest collection. @sample samples.collections.Iterables.Operations.zipIterable """ @@ -1176,7 +1187,8 @@ object Generators : TemplateGroupBase() { infix(true) doc { """ - Returns a list of pairs built from characters of both char sequences with same indexes. List has length of shortest char sequence. + Returns a list of pairs built from the characters of `this` and the [other] char sequences with the same index + The returned list has length of the shortest char sequence. @sample samples.text.Strings.zip """ @@ -1195,7 +1207,8 @@ object Generators : TemplateGroupBase() { infix(true) doc { """ - 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` ${f.collection} and the [other] array with the same index. + The returned list has length of the shortest collection. @sample samples.collections.Iterables.Operations.zipIterable """ @@ -1215,7 +1228,8 @@ object Generators : TemplateGroupBase() { infix(true) doc { """ - 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` array and the [other] array with the same index. + The returned list has length of the shortest collection. @sample samples.collections.Iterables.Operations.zipIterable """ @@ -1234,8 +1248,8 @@ object Generators : TemplateGroupBase() { infix(true) doc { """ - Returns a sequence of pairs built from elements of both sequences with same indexes. - Resulting sequence has length of shortest input sequence. + Returns a sequence of values built from the elements of `this` sequence and the [other] sequence with the same index. + The resulting sequence ends as soon as the shortest input sequence ends. @sample samples.collections.Sequences.Transformations.zip """