summaryrefslogtreecommitdiff
path: root/lib/benchmark.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/benchmark.rb')
-rw-r--r--lib/benchmark.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/benchmark.rb b/lib/benchmark.rb
index 361bca3cad..79c782e262 100644
--- a/lib/benchmark.rb
+++ b/lib/benchmark.rb
@@ -128,6 +128,9 @@ module Benchmark
# benchmark tests. Reserves +label_width+ leading spaces for
# labels on each line. Prints +caption+ at the top of the
# report, and uses +format+ to format each line.
+ # (Note: +caption+ must contain a terminating newline character,
+ # see the default Benchmark::Tms::CAPTION for an example.)
+ #
# Returns an array of Benchmark::Tms objects.
#
# If the block returns an array of