summaryrefslogtreecommitdiff
path: root/io.c
diff options
context:
space:
mode:
Diffstat (limited to 'io.c')
-rw-r--r--io.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/io.c b/io.c
index 1fe9278957..c91899a6fe 100644
--- a/io.c
+++ b/io.c
@@ -11776,12 +11776,16 @@ seek_before_access(VALUE argp)
* IO.read('| cat t.txt')
* # => "First line\nSecond line\n\nThird line\nFourth line\n"
*
- * With only argument +path+ given, reads and returns the entire content
+ * With only argument +path+ given, reads in text mode and returns the entire content
* of the file at the given path:
*
* IO.read('t.txt')
* # => "First line\nSecond line\n\nThird line\nFourth line\n"
*
+ * On Windows, text mode can terminate reading and leave bytes in the file
+ * unread when encountering certain special bytes. Consider using
+ * IO.binread if all bytes in the file should be read.
+ *
* For both forms, command and path, the remaining arguments are the same.
*
* With argument +length+, returns +length+ bytes if available: