aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/persistence.rb
diff options
context:
space:
mode:
authorclaudiob <claudiob@gmail.com>2014-12-30 00:31:04 +0100
committerclaudiob <claudiob@gmail.com>2014-12-30 00:31:04 +0100
commit5e84a24fcd4f9fc365f15adb230069d4beefb7d7 (patch)
tree2303d0b06e2b93d3f4e05bedded9ed01903361de /activerecord/lib/active_record/persistence.rb
parent8beb781d0e959bde3a37abe6473b718f7bc2350b (diff)
downloadrails-5e84a24fcd4f9fc365f15adb230069d4beefb7d7.tar.gz
rails-5e84a24fcd4f9fc365f15adb230069d4beefb7d7.tar.bz2
rails-5e84a24fcd4f9fc365f15adb230069d4beefb7d7.zip
Add doc for `:touch` option of AR::Base#save
ActiveRecord::Base `save` and `save!` take an option boolean `:touch` parameter since #18225 (stems from #18202). This commit document that parameter. [ci skip]
Diffstat (limited to 'activerecord/lib/active_record/persistence.rb')
-rw-r--r--activerecord/lib/active_record/persistence.rb8
1 files changed, 8 insertions, 0 deletions
diff --git a/activerecord/lib/active_record/persistence.rb b/activerecord/lib/active_record/persistence.rb
index ded190c111..f53c5f17ef 100644
--- a/activerecord/lib/active_record/persistence.rb
+++ b/activerecord/lib/active_record/persistence.rb
@@ -109,6 +109,10 @@ module ActiveRecord
# validate: false, validations are bypassed altogether. See
# ActiveRecord::Validations for more information.
#
+ # By default, #save also sets the +updated_at+/+updated_on+ attributes to
+ # the current time. However, if you supply <tt>touch: false</tt>, these
+ # timestamps will not be updated.
+ #
# There's a series of callbacks associated with +save+. If any of the
# <tt>before_*</tt> callbacks return +false+ the action is cancelled and
# +save+ returns +false+. See ActiveRecord::Callbacks for further
@@ -131,6 +135,10 @@ module ActiveRecord
# ActiveRecord::RecordInvalid gets raised. See ActiveRecord::Validations
# for more information.
#
+ # By default, #save! also sets the +updated_at+/+updated_on+ attributes to
+ # the current time. However, if you supply <tt>touch: false</tt>, these
+ # timestamps will not be updated.
+ #
# There's a series of callbacks associated with <tt>save!</tt>. If any of
# the <tt>before_*</tt> callbacks return +false+ the action is cancelled
# and <tt>save!</tt> raises ActiveRecord::RecordNotSaved. See