summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-06-08 07:47:39 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-06-08 07:47:39 +0000
commit38d9aa3f4d7d8b053124e715cbf38191b33fc8e3 (patch)
tree435ddee22035cc022582ea149d4e26605216ca5d
parent545d521cc8582dc1804f9f6ff0b75971be736657 (diff)
ext/stringio/README.md: update [ci skip]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@55326 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--ext/stringio/README18
-rw-r--r--ext/stringio/README.md10
2 files changed, 10 insertions, 18 deletions
diff --git a/ext/stringio/README b/ext/stringio/README
deleted file mode 100644
index d03f37dfd33..00000000000
--- a/ext/stringio/README
+++ /dev/null
@@ -1,18 +0,0 @@
--*- rd -*-
-$Author$
-
-=begin
-
-= StringIO
-Pseudo (({IO})) class from/to (({String})).
-
-This library is based on MoonWolf version written in Ruby. Thanks a lot.
-
-= Differences to (({IO}))
-
-* not implemented: (({fcntl})), (({reopen})).
-* (({fileno})) returns nil.
-* (({pos=})) returns new position, not 0.
-* (({ungetc})) does nothing at start of the string.
-
-=end
diff --git a/ext/stringio/README.md b/ext/stringio/README.md
new file mode 100644
index 00000000000..94532ed688c
--- /dev/null
+++ b/ext/stringio/README.md
@@ -0,0 +1,10 @@
+# StringIO
+
+Pseudo `IO` class from/to `String`.
+
+This library is based on MoonWolf version written in Ruby. Thanks a lot.
+
+## Differences to `IO`
+
+* `fileno` raises `NotImplementedError`.
+* encoding conversion is not implemented, and ignored silently.