* vm_eval.c: [DOC] Fix rdoc formatting of patch from [Bug #9551]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46986 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

ChangeLog

@@ -1,3 +1,7 @@
+Mon Jul 28 06:37:19 2014  Zachary Scott  <e@zzak.io>
+
+	* vm_eval.c: [DOC] Fix rdoc formatting of patch from [Bug #9551]
+
 Mon Jul 28 06:34:43 2014  Zachary Scott  <e@zzak.io>
 
 	* vm_eval.c: [DOC] [Bug #9551] Improve clarity of Kernel::catch

vm_eval.c

@@ -1782,30 +1782,27 @@ catch_i(VALUE tag, VALUE data)
  *  call-seq:
  *     catch([tag]) {|tag| block }  -> obj
  *
- *  +catch+ executes its block. If +throw+ is not called,
+ *  +catch+ executes its block. If +throw+ is not called, the block executes
- *  the block executes normally, and +catch+ returns the
+ *  normally, and +catch+ returns the value of the last expression evaluated.
- *  value of the last expression evaluated.
  *
  *     catch(1) { 123 }            # => 123
  *
- *  If +throw(tag2, val)+ is called, Ruby searches up its
+ *  If +throw(tag2, val)+ is called, Ruby searches up its stack for a +catch+
- *  stack for a +catch+ block whose _tag_ has the same
+ *  block whose +tag+ has the same +object_id+ as _tag2_. When found, the block
- *  +object_id+ as _tag2_. If found, the block stops
+ *  stops executing and returns _val_ (or +nil+ if no second argument was given
- *  executing and returns _val_ (or +nil+ if no second
+ *  to +throw+).
- *  argument was given to +throw+).
  *
  *     catch(1) { throw(1, 456) }  # => 456
  *     catch(1) { throw(1) }       # => nil
  *
- *  When _tag_ is passed as the first argument, +catch+
+ *  When +tag+ is passed as the first argument, +catch+ yields it as the
- *  yields it as the parameter of the block.
+ *  parameter of the block.
  *
  *     catch(1) {|x| x + 2 }       # => 3
  *
- *  When no _tag_ is given, +catch+ yields a new unique
+ *  When no +tag+ is given, +catch+ yields a new unique object (as from
- *  object (as from +Object.new+) as the block parameter.
+ *  +Object.new+) as the block parameter. This object can then be used as the
- *  This object can then be used as the argument to
+ *  argument to +throw+, and will match the correct +catch+ block.
- *  +throw+, and will match the correct +catch+ block.
  *
  *     catch do |obj_A|
  *       catch do |obj_B|