diff options
| author | twinturbo <me@broadcastingadam.com> | 2012-04-29 10:49:21 -0700 |
|---|---|---|
| committer | twinturbo <me@broadcastingadam.com> | 2012-04-29 10:49:21 -0700 |
| commit | 110f3f458afcb4f35d3baa1b5c14c264655dfac9 (patch) | |
| tree | 1145d48435c9127d5ee3c925000dd10ed861235a /activesupport/lib | |
| parent | d7532c189f26e008fc6ef50336ed5e8168b8221c (diff) | |
| download | rails-110f3f458afcb4f35d3baa1b5c14c264655dfac9.tar.gz rails-110f3f458afcb4f35d3baa1b5c14c264655dfac9.tar.bz2 rails-110f3f458afcb4f35d3baa1b5c14c264655dfac9.zip | |
Document ActiveSupport::Deprecations.behavior
Diffstat (limited to 'activesupport/lib')
| -rw-r--r-- | activesupport/lib/active_support/deprecation/behaviors.rb | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/activesupport/lib/active_support/deprecation/behaviors.rb b/activesupport/lib/active_support/deprecation/behaviors.rb index 94f8d7133e..7b343579f9 100644 --- a/activesupport/lib/active_support/deprecation/behaviors.rb +++ b/activesupport/lib/active_support/deprecation/behaviors.rb @@ -11,12 +11,30 @@ module ActiveSupport @behavior ||= [DEFAULT_BEHAVIORS[:stderr]] end - # Sets the behavior to the specified value. Can be a single value or an array. + # Sets the behavior to the specified value. Can be a single value, array, or + # and object that responds to +call+. + # + # Available options: + # + # [+stderr+] Log all deprecation warnings to $stderr + # [+log+] Log all deprecation warnins to +Rails.logger+ + # [+notify] Use +ActiveSupport::Notifications+ to notify of +deprecation.rails+. + # [+silence+] Do nothing + # + # Note, setting behaviors only effects deprecations that happen afterwards. + # For example, All gems are required before Rails boots. Those gems may + # raise deprecation warnings according to the default setting. Setting + # behavior in a config file only effects code after boot time. So, the + # set behavior applies to deprecations raised at runtime. # # Examples # # ActiveSupport::Deprecation.behavior = :stderr # ActiveSupport::Deprecation.behavior = [:stderr, :log] + # ActiveSupport::Deprecation.behavior = proc { |message, callstack| + # # custom stuff + # } + # ActiveSupport::Deprecation.behavior = MyCustomHandler def behavior=(behavior) @behavior = Array(behavior).map { |b| DEFAULT_BEHAVIORS[b] || b } end |