1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

minor doc changes to ActiveSupport::BacktraceCleaner.

This commit is contained in:
Yves Senn 2013-06-12 12:02:45 +02:00
parent f7cf0a3932
commit 3db3f0407e

View file

@ -13,17 +13,17 @@ module ActiveSupport
# can focus on the rest. # can focus on the rest.
# #
# bc = BacktraceCleaner.new # bc = BacktraceCleaner.new
# bc.add_filter { |line| line.gsub(Rails.root, '') } # bc.add_filter { |line| line.gsub(Rails.root, '') } # strip the Rails.root prefix
# bc.add_silencer { |line| line =~ /mongrel|rubygems/ } # bc.add_silencer { |line| line =~ /mongrel|rubygems/ } # skip any lines from mongrel or rubygems
# bc.clean(exception.backtrace) # will strip the Rails.root prefix and 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) # To reconfigure an existing BacktraceCleaner (like the default one in Rails)
# and show as much data as possible, you can always call # and show as much data as possible, you can always call
# <tt>BacktraceCleaner#remove_silencers!</tt>, which will restore the # <tt>BacktraceCleaner#remove_silencers!</tt>, which will restore the
# backtrace to a pristine state. If you need to reconfigure an existing # 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 # 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 # of the backtrace, you can call <tt>BacktraceCleaner#remove_filters!<tt>
# methods will give you a completely untouched backtrace. # These two methods will give you a completely untouched backtrace.
# #
# Inspired by the Quiet Backtrace gem by Thoughtbot. # Inspired by the Quiet Backtrace gem by Thoughtbot.
class BacktraceCleaner class BacktraceCleaner