Document API for create's attributes parameter and provide examples. Closes #7915 [fearoffish]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8296 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

1 files changed, 11 insertions, 2 deletions

diff --git a/activerecord/lib/active_record/base.rb b/activerecord/lib/active_record/base.rb
index 81ee16e380..5330899ece 100755
--- a/activerecord/lib/active_record/base.rb
+++ b/activerecord/lib/active_record/base.rb
@@ -474,8 +474,17 @@ module ActiveRecord #:nodoc:
         false
       end
 
-      # Creates an object, instantly saves it as a record (if the validation permits it), and returns it. If the save
-      # fails under validations, the unsaved object is still returned.
+      # Creates an object (or multiple objects) and saves it to the database, if validations pass.  
+      # The resulting object is returned whether the object was saved successfully to the database or not.
+      #
+      # The +attributes+ parameter can be either be a Hash or an Array of Hashes.  These Hashes describe the
+      # attributes on the objects that are to be created.
+      #
+      # ==== Examples
+      #   # Create a single new object
+      #   User.create(:first_name => 'Jamie')
+      #   # Create an Array of new objects
+      #   User.create([{:first_name => 'Jamie'}, {:first_name => 'Jeremy'}])
       def create(attributes = nil)
         if attributes.is_a?(Array)
           attributes.collect { |attr| create(attr) }