Add example for AR::Persistence#toggle

rails · Nov 21, 2015 · 7461875 · 7461875
1 parent f96b19b
commit 7461875
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/activerecord/lib/active_record/persistence.rb b/activerecord/lib/active_record/persistence.rb
@@ -355,6 +355,14 @@ def decrement!(attribute, by = 1)
     # if the predicate returns +true+ the attribute will become +false+. This
     # method toggles directly the underlying value without calling any setter.
     # Returns +self+.
+    #
+    # Example:
+    #
+    #   user = User.first
+    #   user.banned? # => false
+    #   user.toggle(:banned)
+    #   user.banned? # => true
+    #
     def toggle(attribute)
       self[attribute] = !public_send("#{attribute}?")
       self