Updated new behavior of readLines in scaladoc

davenverse · Aug 23, 2024 · cd4cb57 · cd4cb57
1 parent 0b41b87
commit cd4cb57
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git 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
@@ -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