Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Document options and add examples for update. Closes #7985 [fearoffish]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8293 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
commit 1b7a18dec8ed78ea989270fc3140260fc87c310e 1 parent 6a45e01
Marcel Molina authored
Showing with 12 additions and 6 deletions.
  1. +2 −0  activerecord/CHANGELOG
  2. +10 −6 activerecord/lib/active_record/base.rb
View
2  activerecord/CHANGELOG
@@ -1,5 +1,7 @@
*SVN*
+* Document options and add examples for update. Closes #7985 [fearoffish]
+
* Document options and add examples for delete. Closes #7986 [fearoffish]
* Document options and add examples for destroy. Closes #7988 [fearoffish]
View
16 activerecord/lib/active_record/base.rb
@@ -486,16 +486,20 @@ def create(attributes = nil)
end
end
- # Finds the record from the passed +id+, instantly saves it with the passed +attributes+ (if the validation permits it),
- # and returns it. If the save fails under validations, the unsaved object is still returned.
+ # Updates 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 arguments may also be given as arrays in which case the update method is called for each pair of +id+ and
- # +attributes+ and an array of objects is returned.
+ # ==== Options
+ #
+ # +id+ This should be the id or an array of ids to be updated
+ # +attributes+ This should be a Hash of attributes to be set on the object, or an array of Hashes.
+ #
+ # ==== Examples
#
- # Example of updating one record:
+ # # Updating one record:
# Person.update(15, {:user_name => 'Samuel', :group => 'expert'})
#
- # Example of updating multiple records:
+ # # Updating multiple records:
# people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy"} }
# Person.update(people.keys, people.values)
def update(id, attributes)
Please sign in to comment.
Something went wrong with that request. Please try again.