add example to AS::Deprecation#silence [ci skip]

rails · Jun 17, 2012 · 5085380 · 5085380
1 parent a7a4e91
commit 5085380
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/activesupport/lib/active_support/deprecation/reporting.rb b/activesupport/lib/active_support/deprecation/reporting.rb
@@ -3,7 +3,8 @@ module Deprecation
     class << self
       attr_accessor :silenced
 
-      # Outputs a deprecation warning to the output configured by <tt>ActiveSupport::Deprecation.behavior</tt>
+      # Outputs a deprecation warning to the output configured by
+      # <tt>ActiveSupport::Deprecation.behavior</tt>.
       #
       #   ActiveSupport::Deprecation.warn("something broke!")
       #   # => "DEPRECATION WARNING: something broke! (called from your_code.rb:1)"
@@ -15,6 +16,14 @@ def warn(message = nil, callstack = caller)
       end
 
       # Silence deprecation warnings within the block.
+      #
+      #   ActiveSupport::Deprecation.warn("something broke!")
+      #   # => "DEPRECATION WARNING: something broke! (called from your_code.rb:1)"
+      #
+      #   Activesupport::Deprecation.silence do
+      #     ActiveSupport::Deprecation.warn("something broke!")
+      #   end
+      #   # => nil
       def silence
         old_silenced, @silenced = @silenced, true
         yield