Unify withIndex docs wording

2019-07-30 22:58:08 +03:00
parent 2e445ebad6
commit 65b0a5f903
7 changed files with 39 additions and 19 deletions
@@ -31,7 +31,10 @@ object Mapping : TemplateGroupBase() {
        include(CharSequences, ArraysOfUnsigned)
    } builder {
        doc {
-            "Returns a ${if (f == Sequences) f.mapResult else "lazy [Iterable]"} of [IndexedValue] for each ${f.element} of the original ${f.collection}."
+            """
+            Returns a ${if (f == Sequences) f.mapResult else "lazy [Iterable]"} that wraps each ${f.element} of the original ${f.collection}
+            into an [IndexedValue] containing the index of that ${f.element} and the ${f.element} itself.
+            """
        }
        returns("Iterable<IndexedValue<T>>")
        body {