Document that lines and lineSequence do not preserve line separators

2018-09-25 09:05:09 +03:00
parent 21b71f3bb1
commit 08822ff14b
1 changed files with 5 additions and 1 deletions
@@ -1262,10 +1262,14 @@ public inline fun CharSequence.split(regex: Regex, limit: Int = 0): List<String>

 /**
 * Splits this char sequence to a sequence of lines delimited by any of the following character sequences: CRLF, LF or CR.
+ *
+ * The lines returned do not include terminating line separators.
 */
 public fun CharSequence.lineSequence(): Sequence<String> = splitToSequence("\r\n", "\n", "\r")

 /**
- * * Splits this char sequence to a list of lines delimited by any of the following character sequences: CRLF, LF or CR.
+ * Splits this char sequence to a list of lines delimited by any of the following character sequences: CRLF, LF or CR.
+ *
+ * The lines returned do not include terminating line separators.
 */
 public fun CharSequence.lines(): List<String> = lineSequence().toList()