From c9fe3c3bd0ee5010a36a157fe850ef6e8ffb147d Mon Sep 17 00:00:00 2001
From: Neeraj Singh <neerajdotname@gmail.com>
Date: Tue, 27 Jul 2010 13:55:00 -0400
Subject: adding comments to update_attribute method
---
activerecord/lib/active_record/persistence.rb | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/activerecord/lib/active_record/persistence.rb b/activerecord/lib/active_record/persistence.rb
index b587abd5d0..869cbf5b2e 100644
--- a/activerecord/lib/active_record/persistence.rb
+++ b/activerecord/lib/active_record/persistence.rb
@@ -110,6 +110,10 @@ module ActiveRecord
# * updated_at/updated_on column is updated if that column is available
# * does not work on associations
# * does not work on attr_accessor attributes. The attribute that is being updated must be column name.
+ # * does not work on new record. <tt>record.new_record?</tt> should return false for this method to work.
+ # * updates only the attribute that is input to the method. If there are other changed attributes then
+ # those attributes are left alone. In that case even after this method has done its work <tt>record.changed?</tt>
+ # will return true.
#
def update_attribute(name, value)
raise ActiveRecordError, "#{name.to_s} is marked as readonly" if self.class.readonly_attributes.include? name.to_s
--
cgit v1.2.3