From 465edb96f08e9405b861559c3f7cea3691be5a77 Mon Sep 17 00:00:00 2001
From: Burdette Lamar <BurdetteLamar@Yahoo.com>
Date: Thu, 24 Mar 2022 19:40:58 -0500
Subject: [DOC] Enhanced RDoc for String (#5707)

Treated:

    #chomp
    #chomp!
    #chop
    #chop!
---
 doc/string/chomp.rdoc | 29 ++++++++++++++++++++++++++++
 doc/string/chop.rdoc  | 16 ++++++++++++++++
 string.c              | 53 +++++++++++++++------------------------------------
 3 files changed, 60 insertions(+), 38 deletions(-)
 create mode 100644 doc/string/chomp.rdoc
 create mode 100644 doc/string/chop.rdoc

diff --git a/doc/string/chomp.rdoc b/doc/string/chomp.rdoc
new file mode 100644
index 0000000000..b6fb9ff38c
--- /dev/null
+++ b/doc/string/chomp.rdoc
@@ -0,0 +1,29 @@
+Returns a new string copied from +self+, with trailing characters possibly removed:
+
+When +line_sep+ is <tt>"\n"</tt>, removes the last one or two characters
+if they are <tt>"\r"</tt>, <tt>"\n"</tt>, or <tt>"\r\n"</tt>
+(but not <tt>"\n\r"</tt>):
+
+  $/                    # => "\n"
+  "abc\r".chomp         # => "abc"
+  "abc\n".chomp         # => "abc"
+  "abc\r\n".chomp       # => "abc"
+  "abc\n\r".chomp       # => "abc\n"
+  "тест\r\n".chomp      # => "тест"
+  "こんにちは\r\n".chomp  # => "こんにちは"
+
+When +line_sep+ is <tt>''</tt> (an empty string),
+removes multiple trailing occurrences of <tt>"\n"</tt> or <tt>"\r\n"</tt>
+(but not <tt>"\r"</tt> or <tt>"\n\r"</tt>):
+
+  "abc\n\n\n".chomp('')           # => "abc"
+  "abc\r\n\r\n\r\n".chomp('')     # => "abc"
+  "abc\n\n\r\n\r\n\n\n".chomp('') # => "abc"
+  "abc\n\r\n\r\n\r".chomp('')     # => "abc\n\r\n\r\n\r"
+  "abc\r\r\r".chomp('')           # => "abc\r\r\r"
+
+When +line_sep+ is neither <tt>"\n"</tt> nor <tt>''</tt>,
+removes a single trailing line separator if there is one:
+
+  'abcd'.chomp('d')  # => "abc"
+  'abcdd'.chomp('d') # => "abcd"
diff --git a/doc/string/chop.rdoc b/doc/string/chop.rdoc
new file mode 100644
index 0000000000..8ef82f8a49
--- /dev/null
+++ b/doc/string/chop.rdoc
@@ -0,0 +1,16 @@
+Returns a new string copied from +self+, with trailing characters possibly removed.
+
+Removes <tt>"\r\n"</tt> if those are the last two characters.
+
+  "abc\r\n".chop      # => "abc"
+  "тест\r\n".chop     # => "тест"
+  "こんにちは\r\n".chop # => "こんにちは"
+
+Otherwise removes the last character if it exists.
+
+  'abcd'.chop     # => "abc"
+  'тест'.chop     # => "тес"
+  'こんにちは'.chop # => "こんにち"
+  ''.chop         # => ""
+
+If you only need to remove the newline separator at the end of the string, String#chomp is a better alternative.
diff --git a/string.c b/string.c
index f40d850d5a..9d200ecb20 100644
--- a/string.c
+++ b/string.c
@@ -9452,11 +9452,12 @@ chopped_length(VALUE str)
 
 /*
  *  call-seq:
- *     str.chop!   -> str or nil
+ *    chop! -> self or nil
  *
- *  Processes <i>str</i> as for String#chop, returning <i>str</i>, or
- *  <code>nil</code> if <i>str</i> is the empty string.  See also
- *  String#chomp!.
+ *  Like String#chop, but modifies +self+ in place;
+ *  returns +nil+ if +self+ is empty, +self+ otherwise.
+ *
+ *  Related: String#chomp!.
  */
 
 static VALUE
@@ -9479,20 +9480,10 @@ rb_str_chop_bang(VALUE str)
 
 /*
  *  call-seq:
- *     str.chop   -> new_str
+ *    chop -> new_string
  *
- *  Returns a new String with the last character removed.  If the
- *  string ends with <code>\r\n</code>, both characters are
- *  removed. Applying <code>chop</code> to an empty string returns an
- *  empty string. String#chomp is often a safer alternative, as it
- *  leaves the string unchanged if it doesn't end in a record
- *  separator.
+ *  :include: doc/string/chop.rdoc
  *
- *     "string\r\n".chop   #=> "string"
- *     "string\n\r".chop   #=> "string\n"
- *     "string\n".chop     #=> "string"
- *     "string".chop       #=> "strin"
- *     "x".chop.chop       #=> ""
  */
 
 static VALUE
@@ -9641,11 +9632,11 @@ rb_str_chomp_string(VALUE str, VALUE rs)
 
 /*
  *  call-seq:
- *     str.chomp!(separator=$/)   -> str or nil
+ *    chomp!(line_sep = $/) -> self or nil
+ *
+ *  Like String#chomp, but modifies +self+ in place;
+ *  returns +nil+ if no modification made, +self+ otherwise.
  *
- *  Modifies <i>str</i> in place as described for String#chomp,
- *  returning <i>str</i>, or <code>nil</code> if no modifications were
- *  made.
  */
 
 static VALUE
@@ -9662,24 +9653,10 @@ rb_str_chomp_bang(int argc, VALUE *argv, VALUE str)
 
 /*
  *  call-seq:
- *     str.chomp(separator=$/)   -> new_str
- *
- *  Returns a new String with the given record separator removed
- *  from the end of <i>str</i> (if present). If <code>$/</code> has not been
- *  changed from the default Ruby record separator, then <code>chomp</code> also
- *  removes carriage return characters (that is, it will remove <code>\n</code>,
- *  <code>\r</code>, and <code>\r\n</code>). If <code>$/</code> is an empty string,
- *  it will remove all trailing newlines from the string.
- *
- *     "hello".chomp                #=> "hello"
- *     "hello\n".chomp              #=> "hello"
- *     "hello\r\n".chomp            #=> "hello"
- *     "hello\n\r".chomp            #=> "hello\n"
- *     "hello\r".chomp              #=> "hello"
- *     "hello \n there".chomp       #=> "hello \n there"
- *     "hello".chomp("llo")         #=> "he"
- *     "hello\r\n\r\n".chomp('')    #=> "hello"
- *     "hello\r\n\r\r\n".chomp('')  #=> "hello\r\n\r"
+ *    chomp(line_sep = $/) -> new_string
+ *
+ *  :include: doc/string/chomp.rdoc
+ *
  */
 
 static VALUE
-- 
cgit v1.2.3