diff options
| author | Marcel Molina <marcel@vernix.org> | 2007-05-06 05:19:02 +0000 |
|---|---|---|
| committer | Marcel Molina <marcel@vernix.org> | 2007-05-06 05:19:02 +0000 |
| commit | f02a0bf274da62e96c6986298294c23e6285e63c (patch) | |
| tree | d5a47f1bcca9c291b45e2ef8f71b112a3adf9751 | |
| parent | ca3e89d4de727ca43b9c6cd7049364c35649aabd (diff) | |
| download | rails-f02a0bf274da62e96c6986298294c23e6285e63c.tar.gz rails-f02a0bf274da62e96c6986298294c23e6285e63c.tar.bz2 rails-f02a0bf274da62e96c6986298294c23e6285e63c.zip | |
Minor wording tweak to documentation for the debug helper. Closes #8037. [jeremymcanally]
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6688 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
| -rw-r--r-- | actionpack/lib/action_view/helpers/debug_helper.rb | 8 |
1 files changed, 6 insertions, 2 deletions
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 <pre>-tag set with the +object+ dumped by YAML. Very readable way to inspect an object. + # Returns a <pre>-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) + # # => <pre class='debug_dump'>--- # first: 1 # second: two |