Permalink
Browse files

Enhance documentation for decrement_counter. Closes #8093. [fearoffish]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6683 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
1 parent 194b4aa commit 5bd35705cae2e465b2fe2b2038bb409b63b78438 Marcel Molina committed May 6, 2007
Showing with 15 additions and 1 deletion.
  1. +2 −0 activerecord/CHANGELOG
  2. +13 −1 activerecord/lib/active_record/base.rb
@@ -1,5 +1,7 @@
*SVN*
+* Enhance documentation for decrement_counter. [fearoffish]
+
* Provide brief introduction to what optimistic locking is. [fearoffish]
* Add documentation for :encoding option to mysql adapter. [marclove]
@@ -564,7 +564,19 @@ def increment_counter(counter_name, id)
update_counters(id, counter_name => 1)
end
- # Works like increment_counter, but decrements instead.
+ # Decrement a number field by one, usually representing a count.
+ #
+ # This works the same as increment_counter but reduces the column value by 1 instead of increasing it.
+ #
+ # ==== Options
+ #
+ # +counter_name+ The name of the field that should be decremented
+ # +id+ The id of the object that should be decremented
+ #
+ # ==== Examples
+ #
+ # # Decrement the post_count column for the record with an id of 5
+ # DiscussionBoard.decrement_counter(:post_count, 5)
def decrement_counter(counter_name, id)
update_counters(id, counter_name => -1)
end

0 comments on commit 5bd3570

Please sign in to comment.