From 0b4214ad9b53c2978cbca3ac08d467f03bdabd8d Mon Sep 17 00:00:00 2001
From: zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Wed, 24 Apr 2013 04:47:31 +0000
Subject: * class.c: Example of Object#methods by @windwiny [Fixes GH-293] *
 ruby.c: Document return values of Kernel #sub, #gsub, and #chop

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40432 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 ruby.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'ruby.c')

diff --git a/ruby.c b/ruby.c
index 6b61162a8a..c1c65137af 100644
--- a/ruby.c
+++ b/ruby.c
@@ -1241,7 +1241,7 @@ uscore_get(void)
 /*
  *  call-seq:
  *     sub(pattern, replacement)   -> $_
- *     sub(pattern) { block }      -> $_
+ *     sub(pattern) {|...| block } -> $_
  *
  *  Equivalent to <code>$_.sub(<i>args</i>)</code>, except that
  *  <code>$_</code> will be updated if substitution occurs.
@@ -1258,11 +1258,11 @@ rb_f_sub(int argc, VALUE *argv)
 
 /*
  *  call-seq:
- *     gsub(pattern, replacement)    -> string
- *     gsub(pattern) {|...| block }  -> string
+ *     gsub(pattern, replacement)    -> $_
+ *     gsub(pattern) {|...| block }  -> $_
  *
  *  Equivalent to <code>$_.gsub...</code>, except that <code>$_</code>
- *  receives the modified result.
+ *  will be updated if substitution occurs.
  *  Available only when -p/-n command line option specified.
  *
  */
@@ -1277,7 +1277,7 @@ rb_f_gsub(int argc, VALUE *argv)
 
 /*
  *  call-seq:
- *     chop   -> string
+ *     chop   -> $_
  *
  *  Equivalent to <code>($_.dup).chop!</code>, except <code>nil</code>
  *  is never returned. See <code>String#chop!</code>.
-- 
cgit v1.2.3