Permalink
Browse files

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
  • Loading branch information...
1 parent a7e6e00 commit a23bea7c0d16d159b38650770baafd0c09d2ca78 Marcel Molina committed Dec 5, 2007
Showing with 13 additions and 2 deletions.
  1. +2 −0 activerecord/CHANGELOG
  2. +11 −2 activerecord/lib/active_record/base.rb
@@ -1,5 +1,7 @@
*SVN*
+* Document API for create's attributes parameter and provide examples. Closes #7915 [fearoffish]
+
* Documentation for find incorrectly omits the :conditions option from various examples. Closes #7923 [mattwestcott]
* Document options and add examples for update. Closes #7985 [fearoffish]
@@ -474,8 +474,17 @@ def exists?(id_or_conditions)
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) }

0 comments on commit a23bea7

Please sign in to comment.