diff --git a/actionpack/lib/action_view/helpers/debug_helper.rb b/actionpack/lib/action_view/helpers/debug_helper.rb index ef089c1bad..20de7e465f 100644 --- a/actionpack/lib/action_view/helpers/debug_helper.rb +++ b/actionpack/lib/action_view/helpers/debug_helper.rb @@ -1,10 +1,14 @@ module ActionView module Helpers - # Provides a set of methods for making it easier to locate problems. + # Provides a set of methods for making it easier to debug Rails objects. module DebugHelper - # Returns a
-tag set with the +object+ dumped by YAML. Very readable way to inspect an object.
+ # Returns a -tag that has +object+ dumped by YAML. This creates a very
+ # readable way to inspect an object.
+ #
+ # ==== Example
# my_hash = {'first' => 1, 'second' => 'two', 'third' => [1,2,3]}
# debug(my_hash)
+ #
# => ---
# first: 1
# second: two