From cd4cb5776fd6fe298cbac5f5b8cab34c92881e31 Mon Sep 17 00:00:00 2001 From: Hombre-x Date: Fri, 23 Aug 2024 01:07:10 -0500 Subject: [PATCH] Updated new behavior of `readLines` in scaladoc --- core/src/main/scala/io/chrisdavenport/shellfish/FilesOs.scala | 3 ++- .../io/chrisdavenport/shellfish/syntax/path/package.scala | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/core/src/main/scala/io/chrisdavenport/shellfish/FilesOs.scala b/core/src/main/scala/io/chrisdavenport/shellfish/FilesOs.scala index 2df8fa4..e3d90bd 100644 --- a/core/src/main/scala/io/chrisdavenport/shellfish/FilesOs.scala +++ b/core/src/main/scala/io/chrisdavenport/shellfish/FilesOs.scala @@ -81,7 +81,8 @@ object FilesOs { /** * Reads the contents of the file at the path using UTF-8 decoding and returns - * it line by line as a List of Strings. + * it line by line as a List of Strings. It will ignore any empty characters + * after the last newline (similar to `wc -l`). * * @param path * The path to read from diff --git a/core/src/main/scala/io/chrisdavenport/shellfish/syntax/path/package.scala b/core/src/main/scala/io/chrisdavenport/shellfish/syntax/path/package.scala index 636f1a2..d70c190 100644 --- a/core/src/main/scala/io/chrisdavenport/shellfish/syntax/path/package.scala +++ b/core/src/main/scala/io/chrisdavenport/shellfish/syntax/path/package.scala @@ -75,7 +75,8 @@ package object path { /** * Reads the contents of the file at the path using UTF-8 decoding and - * returns it line by line as a List of Strings. + * returns it line by line as a List of Strings. It will ignore any empty + * characters after the last newline (similar to `wc -l`). * * @param path * The path to read from