Ruby on Rails | Screencasts | Download | Documentation | Weblog | Community | Source

Changeset 6688

Show
Ignore:
Timestamp:
05/06/07 05:19:02 (2 years ago)
Author:
marcel
Message:

Minor wording tweak to documentation for the debug helper. Closes #8037. [jeremymcanally]

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/actionpack/lib/action_view/helpers/debug_helper.rb

    r6470 r6688  
    11module ActionView 
    22  module Helpers 
    3     # Provides a set of methods for making it easier to locate problems. 
     3    # Provides a set of methods for making it easier to debug Rails objects. 
    44    module DebugHelper 
    5       # Returns a <pre>-tag set with the +object+ dumped by YAML. Very readable way to inspect an object. 
     5      # Returns a <pre>-tag that has +object+ dumped by YAML. This creates a very 
     6      # readable way to inspect an object. 
     7      # 
     8      # ==== Example 
    69      #  my_hash = {'first' => 1, 'second' => 'two', 'third' => [1,2,3]} 
    710      #  debug(my_hash) 
     11      # 
    812      #  => <pre class='debug_dump'>---  
    913      #  first: 1