lib/action_controller/assertions/model_assertions.rb in actionpack-1.13.6 vs lib/action_controller/assertions/model_assertions.rb in actionpack-2.0.0

@@ -1,12 +1,19 @@
 module ActionController
   module Assertions
     module ModelAssertions
       # Ensures that the passed record is valid by ActiveRecord standards and returns any error messages if it is not.
+      #
+      # ==== Examples
+      #
+      #   # assert that a newly created record is valid
+      #   model = Model.new
+      #   assert_valid(model)
+      #
       def assert_valid(record)
         clean_backtrace do
           assert record.valid?, record.errors.full_messages.join("\n")
         end
       end
     end
   end
-end
\ No newline at end of file
+end