diff options
| author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2025-12-22 18:43:58 -0600 |
|---|---|---|
| committer | Hiroshi SHIBATA <hsbt@ruby-lang.org> | 2025-12-26 11:00:51 +0900 |
| commit | ae46f916f1e686b5f7cc80402f2e8b5f299abc3c (patch) | |
| tree | a44ff13552167f57440896135827bb16aced8eb1 /ext | |
| parent | 9a76ccdbabbd7d2814a3106cc10d2740b6120ab9 (diff) | |
[ruby/stringio] [DOC] Doc for StringIO#read
(https://github.com/ruby/stringio/pull/197)
Previous doc merely linked to `IO#read`; new doc stays local, shows
examples using `StringIO`.
https://github.com/ruby/stringio/commit/e8b66f8cdd
Diffstat (limited to 'ext')
| -rw-r--r-- | ext/stringio/stringio.c | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/ext/stringio/stringio.c b/ext/stringio/stringio.c index fa2a36cd0e..93a419ff31 100644 --- a/ext/stringio/stringio.c +++ b/ext/stringio/stringio.c @@ -1650,9 +1650,10 @@ strio_putc(VALUE self, VALUE ch) /* * call-seq: - * strio.read([length [, outbuf]]) -> string, outbuf, or nil + * read(maxlen = nil, out_string = nil) → new_string, out_string, or nil + * + * :include: stringio/read.rdoc * - * See IO#read. */ static VALUE strio_read(int argc, VALUE *argv, VALUE self) |