aboutsummaryrefslogtreecommitdiffstats
path: root/io.c
diff options
context:
space:
mode:
authorRyan Davis <ryand-github@zenspider.com>2023-12-01 14:51:08 -0800
committerGitHub <noreply@github.com>2023-12-01 22:51:08 +0000
commit6ecc1ca9b1afc5e863f82db3bb23a1ef59469817 (patch)
tree152db2a9f7d438a80744c92b3707b970c3eb1048 /io.c
parent0aed37b973c66e9ff071a1f46944cb0c6151d2dc (diff)
downloadruby-6ecc1ca9b1afc5e863f82db3bb23a1ef59469817.tar.gz
[DOC] Update ARGF.readlines documentation to match/reference IO.readlines.
Diffstat (limited to 'io.c')
-rw-r--r--io.c14
1 files changed, 8 insertions, 6 deletions
diff --git a/io.c b/io.c
index 7ded212804..5924d6cd26 100644
--- a/io.c
+++ b/io.c
@@ -10468,19 +10468,21 @@ rb_f_readlines(int argc, VALUE *argv, VALUE recv)
/*
* call-seq:
- * ARGF.readlines(sep = $/) -> array
- * ARGF.readlines(limit) -> array
- * ARGF.readlines(sep, limit) -> array
+ * ARGF.readlines(sep = $/, chomp: false) -> array
+ * ARGF.readlines(limit, chomp: false) -> array
+ * ARGF.readlines(sep, limit, chomp: false) -> array
*
- * ARGF.to_a(sep = $/) -> array
- * ARGF.to_a(limit) -> array
- * ARGF.to_a(sep, limit) -> array
+ * ARGF.to_a(sep = $/, chomp: false) -> array
+ * ARGF.to_a(limit, chomp: false) -> array
+ * ARGF.to_a(sep, limit, chomp: false) -> array
*
* Reads each file in ARGF in its entirety, returning an Array containing
* lines from the files. Lines are assumed to be separated by _sep_.
*
* lines = ARGF.readlines
* lines[0] #=> "This is line one\n"
+ *
+ * See +IO.readlines+ for a full description of all options.
*/
static VALUE
argf_readlines(int argc, VALUE *argv, VALUE argf)