Skip to content

Commit 487dbe1

Browse files
committed
[DOC] Doc for StringIO#read
1 parent e2d24ae commit 487dbe1

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

doc/stringio/read.rdoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Reads and returns bytes from the stream.
2+
3+
With no arguments,

ext/stringio/stringio.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1649,9 +1649,10 @@ strio_putc(VALUE self, VALUE ch)
16491649

16501650
/*
16511651
* call-seq:
1652-
* strio.read([length [, outbuf]]) -> string, outbuf, or nil
1652+
* read(maxlen = nil, out_string = nil) → new_string, out_string, or nil
1653+
*
1654+
* :include: stringio/read.rdoc
16531655
*
1654-
* See IO#read.
16551656
*/
16561657
static VALUE
16571658
strio_read(int argc, VALUE *argv, VALUE self)

0 commit comments

Comments
 (0)