summaryrefslogtreecommitdiff
path: root/doc/string/chop.rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/string/chop.rdoc')
-rw-r--r--doc/string/chop.rdoc17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/string/chop.rdoc b/doc/string/chop.rdoc
new file mode 100644
index 0000000000..d818ba467a
--- /dev/null
+++ b/doc/string/chop.rdoc
@@ -0,0 +1,17 @@
+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 # => "こんにちは"
+
+Otherwise removes the last character if it exists.
+
+ 'abcd'.chop # => "abc"
+ 'こんにちは'.chop # => "こんにち"
+ ''.chop # => ""
+
+If you only need to remove the newline separator at the end of the string,
+String#chomp is a better alternative.
+
+Related: see {Converting to New String}[rdoc-ref:String@Converting+to+New+String].