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

Clarify docs of CharSequence.split(Pattern, limit)

Browse Source 
Emphasize differences from Pattern.split(CharSequence, limit).

#KT-39023 Fixed
This commit is contained in:
Ilya Gorbunov
2020-05-22 21:06:07 +03:00
parent f3145454f2
commit dae7a23998
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/jvm/src/kotlin/text/StringsJVM.kt
+5
View File
@@ -301,6 +301,11 @@ public inline fun String.Companion.format(locale: Locale?, format: String, varar
/** /**
* Splits this char sequence around matches of the given regular expression. * Splits this char sequence around matches of the given regular expression.
*
* This function has two notable differences from the method [Pattern.split]:
* - the function returns the result as a `List<String>` rather than an `Array<String>`;
* - when the [limit] is not specified or specified as 0,
* this function doesn't drop trailing empty strings from the result.
* @param limit Non-negative value specifying the maximum number of substrings to return. * @param limit Non-negative value specifying the maximum number of substrings to return.
* Zero by default means no limit is set. * Zero by default means no limit is set.