aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support/backtrace_cleaner.rb
diff options
context:
space:
mode:
authorYves Senn <yves.senn@gmail.com>2013-06-12 12:02:45 +0200
committerYves Senn <yves.senn@gmail.com>2013-06-12 12:02:45 +0200
commit3db3f0407e154fcc55566d2cd3b41854912a6365 (patch)
tree45fa7b5b1218e357154eabdaec5f3a8052fbf1f8 /activesupport/lib/active_support/backtrace_cleaner.rb
parentf7cf0a39322e2dd706aeb84e6cc1bfca7c93df39 (diff)
downloadrails-3db3f0407e154fcc55566d2cd3b41854912a6365.tar.gz
rails-3db3f0407e154fcc55566d2cd3b41854912a6365.tar.bz2
rails-3db3f0407e154fcc55566d2cd3b41854912a6365.zip
minor doc changes to `ActiveSupport::BacktraceCleaner`.
Diffstat (limited to 'activesupport/lib/active_support/backtrace_cleaner.rb')
-rw-r--r--activesupport/lib/active_support/backtrace_cleaner.rb10
1 files changed, 5 insertions, 5 deletions
diff --git a/activesupport/lib/active_support/backtrace_cleaner.rb b/activesupport/lib/active_support/backtrace_cleaner.rb
index 4b41e6247d..6f9dc679c2 100644
--- a/activesupport/lib/active_support/backtrace_cleaner.rb
+++ b/activesupport/lib/active_support/backtrace_cleaner.rb
@@ -13,17 +13,17 @@ module ActiveSupport
# can focus on the rest.
#
# bc = BacktraceCleaner.new
- # bc.add_filter { |line| line.gsub(Rails.root, '') }
- # bc.add_silencer { |line| line =~ /mongrel|rubygems/ }
- # bc.clean(exception.backtrace) # will strip the Rails.root prefix and skip any lines from mongrel or rubygems
+ # bc.add_filter { |line| line.gsub(Rails.root, '') } # strip the Rails.root prefix
+ # bc.add_silencer { |line| line =~ /mongrel|rubygems/ } # skip any lines from mongrel or rubygems
+ # bc.clean(exception.backtrace) # perform the cleanup
#
# To reconfigure an existing BacktraceCleaner (like the default one in Rails)
# and show as much data as possible, you can always call
# <tt>BacktraceCleaner#remove_silencers!</tt>, which will restore the
# backtrace to a pristine state. If you need to reconfigure an existing
# BacktraceCleaner so that it does not filter or modify the paths of any lines
- # of the backtrace, you can call BacktraceCleaner#remove_filters! These two
- # methods will give you a completely untouched backtrace.
+ # of the backtrace, you can call <tt>BacktraceCleaner#remove_filters!<tt>
+ # These two methods will give you a completely untouched backtrace.
#
# Inspired by the Quiet Backtrace gem by Thoughtbot.
class BacktraceCleaner