aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/assertions/model_assertions.rb
diff options
context:
space:
mode:
Diffstat (limited to 'actionpack/lib/action_controller/assertions/model_assertions.rb')
-rw-r--r--actionpack/lib/action_controller/assertions/model_assertions.rb9
1 files changed, 8 insertions, 1 deletions
diff --git a/actionpack/lib/action_controller/assertions/model_assertions.rb b/actionpack/lib/action_controller/assertions/model_assertions.rb
index 5fc5c81cb7..0b4313055a 100644
--- a/actionpack/lib/action_controller/assertions/model_assertions.rb
+++ b/actionpack/lib/action_controller/assertions/model_assertions.rb
@@ -2,6 +2,13 @@ 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")
@@ -9,4 +16,4 @@ module ActionController
end
end
end
-end \ No newline at end of file
+end