diff options
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | string.c | 21 |
2 files changed, 17 insertions, 9 deletions
@@ -1,3 +1,8 @@ +Tue Dec 9 20:24:41 2014 SHIBATA Hiroshi <shibata.hiroshi@gmail.com> + + * string.c: [DOC] Add missing documentation around String#chomp. + Patchby @stderr [ci skip][fix GH-780] + Tue Dec 9 18:20:02 2014 Nobuyoshi Nakada <nobu@ruby-lang.org> * object.c: [DOC] Revise documentation by Marcus Stollsteimer at @@ -7161,15 +7161,18 @@ rb_str_chomp_bang(int argc, VALUE *argv, VALUE str) * 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>). - * - * "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" + * <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" */ static VALUE |