summaryrefslogtreecommitdiff
path: root/ext
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2025-12-22 18:42:36 -0600
committerHiroshi SHIBATA <hsbt@ruby-lang.org>2025-12-26 11:00:51 +0900
commit354dc574de421e6cbfb4404abc49a5be462042a9 (patch)
treefeaafce22335686cff27b3a27bee1a7996a75855 /ext
parent67f830e0925c328c19fc1c2f513a174c6e3ca63d (diff)
[ruby/stringio] [DOC] Doc for StringIO#pread
(https://github.com/ruby/stringio/pull/195) Previous doc unhelpfully pointed to `IO#pread`; this PR documents locally, with StringIO examples. https://github.com/ruby/stringio/commit/806f3d9741
Diffstat (limited to 'ext')
-rw-r--r--ext/stringio/stringio.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/ext/stringio/stringio.c b/ext/stringio/stringio.c
index 11b3fff39c..1772be5f52 100644
--- a/ext/stringio/stringio.c
+++ b/ext/stringio/stringio.c
@@ -1723,10 +1723,10 @@ strio_read(int argc, VALUE *argv, VALUE self)
/*
* call-seq:
- * pread(maxlen, offset) -> string
- * pread(maxlen, offset, out_string) -> string
+ * pread(maxlen, offset, out_string = nil) -> new_string or out_string
+ *
+ * :include: stringio/pread.rdoc
*
- * See IO#pread.
*/
static VALUE
strio_pread(int argc, VALUE *argv, VALUE self)