summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2025-10-27 16:52:28 +0900
committergit <svn-admin@ruby-lang.org>2025-10-27 07:53:15 +0000
commitd0a6780d1ec267e382053eae46ccf681f13dd50f (patch)
tree7ed0697c8edfc7516ee89380f01c3033bf696c9d
parentd17d49d4aa81ea7a134629aefd1efa5e9c7a6d1a (diff)
[ruby/stringio] [DOC] Split the examples `StringIO` into the document file
https://github.com/ruby/stringio/commit/04ba28af00
-rw-r--r--doc/stringio/stringio.md26
-rw-r--r--ext/stringio/stringio.c28
2 files changed, 27 insertions, 27 deletions
diff --git a/doc/stringio/stringio.md b/doc/stringio/stringio.md
new file mode 100644
index 0000000000..345fc5f207
--- /dev/null
+++ b/doc/stringio/stringio.md
@@ -0,0 +1,26 @@
+\IO streams for strings, with access similar to
+{IO}[rdoc-ref:IO];
+see {IO}[rdoc-ref:IO].
+
+### About the Examples
+
+Examples on this page assume that \StringIO has been required:
+
+```
+require 'stringio'
+```
+
+And that these constants have been defined:
+
+```
+TEXT = <<EOT
+First line
+Second line
+
+Fourth line
+Fifth line
+EOT
+
+RUSSIAN = 'тест'
+DATA = "\u9990\u9991\u9992\u9993\u9994"
+```
diff --git a/ext/stringio/stringio.c b/ext/stringio/stringio.c
index 3c842265af..b6ab8cd6cf 100644
--- a/ext/stringio/stringio.c
+++ b/ext/stringio/stringio.c
@@ -2133,33 +2133,7 @@ strio_set_encoding_by_bom(VALUE self)
/*
* :markup: markdown
*
- * \IO streams for strings, with access similar to
- * {IO}[rdoc-ref:IO];
- * see {IO}[rdoc-ref:IO].
- *
- * ### About the Examples
- *
- * Examples on this page assume that \StringIO has been required:
- *
- * ```
- * require 'stringio'
- * ```
- *
- * And that these constants have been defined:
- *
- * ```
- * TEXT = <<EOT
- * First line
- * Second line
- *
- * Fourth line
- * Fifth line
- * EOT
- *
- * RUSSIAN = 'тест'
- * DATA = "\u9990\u9991\u9992\u9993\u9994"
- * ```
- *
+ * :include: stringio/stringio.md
*/
void
Init_stringio(void)