From 3e5d7e31763362ecf98259755694585902d89f80 Mon Sep 17 00:00:00 2001
From: Nobuyoshi Nakada <nobu@ruby-lang.org>
Date: Wed, 12 Aug 2020 16:03:23 +0900
Subject: [DOC] Move String.new to allow non US-ASCII characters

---
 doc/string.rb | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 string.c      | 46 ----------------------------------------------
 2 files changed, 48 insertions(+), 46 deletions(-)
 create mode 100644 doc/string.rb

diff --git a/doc/string.rb b/doc/string.rb
new file mode 100644
index 0000000000..65bfa39272
--- /dev/null
+++ b/doc/string.rb
@@ -0,0 +1,48 @@
+class String
+  # call-seq:
+  #   String.new(string = '') -> new_string
+  #   String.new(string = '', encoding: encoding) -> new_string
+  #   String.new(string = '', capacity: size) -> new_string
+  #
+  # Returns a new \String that is a copy of +string+.
+  #
+  # With no arguments, returns the empty string with the Encoding <tt>ASCII-8BIT</tt>:
+  #   s = String.new
+  #   s # => ""
+  #   s.encoding # => #<Encoding:ASCII-8BIT>
+  #
+  # With the single \String argument +string+, returns a copy of +string+
+  # with the same encoding as +string+:
+  #   s = String.new('Que veut dire ça?')
+  #   s # => "Que veut dire ça?"
+  #   s.encoding # => #<Encoding:UTF-8>
+  #
+  # Literal strings like <tt>""</tt> or here-documents always use
+  # Encoding@Script+encoding, unlike String.new.
+  #
+  # With keyword +encoding+, returns a copy of +str+
+  # with the specified encoding:
+  #   s = String.new(encoding: 'ASCII')
+  #   s.encoding # => #<Encoding:US-ASCII>
+  #   s = String.new('foo', encoding: 'ASCII')
+  #   s.encoding # => #<Encoding:US-ASCII>
+  #
+  # Note that these are equivalent:
+  #   s0 = String.new('foo', encoding: 'ASCII')
+  #   s1 = 'foo'.force_encoding('ASCII')
+  #   s0.encoding == s1.encoding # => true
+  #
+  # With keyword +capacity+, returns a copy of +str+;
+  # the given +capacity+ may set the size of the internal buffer,
+  # which may affect performance:
+  #   String.new(capacity: 1) # => ""
+  #   String.new(capacity: 4096) # => ""
+  #
+  # The +string+, +encoding+, and +capacity+ arguments may all be used together:
+  #
+  #   String.new('hello', encoding: 'UTF-8', capacity: 25)
+  #
+  def initialize(str = '', encoding: nil, capacity: nil)
+    Primitive.rb_str_init(str, encoding, capacity)
+  end
+end
diff --git a/string.c b/string.c
index 0fdde85b17..4b35b076e0 100644
--- a/string.c
+++ b/string.c
@@ -1810,52 +1810,6 @@ rb_ec_str_resurrect(struct rb_execution_context_struct *ec, VALUE str)
     return ec_str_duplicate(ec, rb_cString, str);
 }
 
-/*
- *  call-seq:
- *    String.new(string = '') -> new_string
- *    String.new(string = '', encoding: encoding) -> new_string
- *    String.new(string = '', capacity: size) -> new_string
- *
- *  Returns a new \String that is a copy of +string+.
- *
- *  With no arguments, returns the empty string with the Encoding <tt>ASCII-8BIT</tt>:
- *    s = String.new
- *    s # => ""
- *    s.encoding # => #<Encoding:ASCII-8BIT>
- *
- *  With the single \String argument +string+, returns a copy of +string+
- *  with the same encoding as +string+:
- *    s = String.new("Que veut dire \u{e7}a?")
- *    s # => "Que veut dire \u{e7}a?"
- *    s.encoding # => #<Encoding:UTF-8>
- *
- *  Literal strings like <tt>""</tt> or here-documents always use
- *  Encoding@Script+encoding, unlike String.new.
- *
- *  With keyword +encoding+, returns a copy of +str+
- *  with the specified encoding:
- *    s = String.new(encoding: 'ASCII')
- *    s.encoding # => #<Encoding:US-ASCII>
- *    s = String.new('foo', encoding: 'ASCII')
- *    s.encoding # => #<Encoding:US-ASCII>
- *
- *  Note that these are equivalent:
- *    s0 = String.new('foo', encoding: 'ASCII')
- *    s1 = 'foo'.force_encoding('ASCII')
- *    s0.encoding == s1.encoding # => true
- *
- *  With keyword +capacity+, returns a copy of +str+;
- *  the given +capacity+ may set the size of the internal buffer,
- *  which may affect performance:
- *    String.new(capacity: 1) # => ""
- *    String.new(capacity: 4096) # => ""
- *
- *  The +string+, +encoding+, and +capacity+ arguments may all be used together:
- *
- *    String.new('hello', encoding: 'UTF-8', capacity: 25)
- *
- */
-
 static VALUE
 rb_str_init(int argc, VALUE *argv, VALUE str)
 {
-- 
cgit v1.2.3