diff options
author | Matt Jankowski <mjankowski@thoughtbot.com> | 2011-07-01 10:05:45 -0400 |
---|---|---|
committer | Matt Jankowski <mjankowski@thoughtbot.com> | 2011-07-01 10:05:45 -0400 |
commit | 894cca5cc5dc3ad8a8285f7a3b8e16e70484d9cd (patch) | |
tree | 69c2d7d06b9003793ebff01b1162703deccf5582 /activesupport | |
parent | 8de6ded7a5aa243d3b7eca246384fb65fcdf91da (diff) | |
download | rails-894cca5cc5dc3ad8a8285f7a3b8e16e70484d9cd.tar.gz rails-894cca5cc5dc3ad8a8285f7a3b8e16e70484d9cd.tar.bz2 rails-894cca5cc5dc3ad8a8285f7a3b8e16e70484d9cd.zip |
general formatting cleanup, and clarify that passing true as third option for benchmarking will stop output OTHER THAN the timing output itself
Diffstat (limited to 'activesupport')
-rw-r--r-- | activesupport/lib/active_support/benchmarkable.rb | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/activesupport/lib/active_support/benchmarkable.rb b/activesupport/lib/active_support/benchmarkable.rb index e303eaa5ce..cc94041a1d 100644 --- a/activesupport/lib/active_support/benchmarkable.rb +++ b/activesupport/lib/active_support/benchmarkable.rb @@ -3,28 +3,28 @@ require 'active_support/core_ext/hash/keys' module ActiveSupport module Benchmarkable - # Allows you to measure the execution time of a block - # in a template and records the result to the log. Wrap this block around - # expensive operations or possible bottlenecks to get a time reading - # for the operation. For example, let's say you thought your file - # processing method was taking too long; you could wrap it in a benchmark block. + # Allows you to measure the execution time of a block in a template and records the result to + # the log. Wrap this block around expensive operations or possible bottlenecks to get a time + # reading for the operation. For example, let's say you thought your file processing method + # was taking too long; you could wrap it in a benchmark block. # # <% benchmark "Process data files" do %> # <%= expensive_files_operation %> # <% end %> # - # That would add something like "Process data files (345.2ms)" to the log, - # which you can then use to compare timings when optimizing your code. + # That would add something like "Process data files (345.2ms)" to the log, which you can then + # use to compare timings when optimizing your code. # - # You may give an optional logger level as the :level option. - # (:debug, :info, :warn, :error); the default value is :info. + # You may give an optional logger level (:debug, :info, :warn, :error) as the :level option. + # The default logger level value is :info. # # <% benchmark "Low-level files", :level => :debug do %> # <%= lowlevel_files_operation %> # <% end %> # - # Finally, you can pass true as the third argument to silence all log activity - # inside the block. This is great for boiling down a noisy block to just a single statement: + # Finally, you can pass true as the third argument to silence all log activity (other than the + # timing information) from inside the block. This is great for boiling down a noisy block to + # just a single statement that produces one log line: # # <% benchmark "Process data files", :level => :info, :silence => true do %> # <%= expensive_and_chatty_files_operation %> |