From 354dc574de421e6cbfb4404abc49a5be462042a9 Mon Sep 17 00:00:00 2001
From: Burdette Lamar <BurdetteLamar@Yahoo.com>
Date: Mon, 22 Dec 2025 18:42:36 -0600
Subject: [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
---
 ext/stringio/stringio.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'ext')

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)
-- 
cgit v1.2.3