Documentation changes for should_change

wfarr · Jun 9, 2009 · af142c6 · af142c6
1 parent d13a460
commit af142c6
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/lib/shoulda/macros.rb b/lib/shoulda/macros.rb
@@ -26,9 +26,14 @@ module Macros
     #
     # Combinations of <tt>:by</tt>, <tt>:from</tt>, and <tt>:to</tt> are allowed:
     #
-    #   should_change("the post title") { @post.title }                 # => assert the value changed in some way
-    #   should_change("the post title", :from => "old") { @post.title } # => assert the value changed to anything other than "old"
-    #   should_change("the post title", :to   => "new") { @post.title } # => assert the value changed from anything other than "new"
+    #   # Assert the value changed in some way:
+    #   should_change("the post title") { @post.title }
+    #
+    #   # Assert the value changed to anything other than "old:"
+    #   should_change("the post title", :from => "old") { @post.title }
+    #
+    #   # Assert the value changed to "new:"
+    #   should_change("the post title", :to => "new") { @post.title }
     def should_change(description, options = {}, &block)
       by, from, to = get_options!([options], :by, :from, :to)
       stmt = "change #{description}"