diff options
author | Keith Bennett <keithrbennett@gmail.com> | 2021-03-03 15:13:30 -0500 |
---|---|---|
committer | Hiroshi SHIBATA <hsbt@ruby-lang.org> | 2021-04-22 11:51:37 +0900 |
commit | 4f39a35b60de7fe80ace6978aae3346f0d76ced4 (patch) | |
tree | 87a5f0e970648cae630db75aac34f9cff1a4616f /lib/benchmark.rb | |
parent | 2440d60acb8e8fbcad1f6943892556cf3a529d70 (diff) |
[ruby/benchmark] Add comment about terminating newline in captions; fix test method name.
https://github.com/ruby/benchmark/commit/02ce298d3e
Diffstat (limited to 'lib/benchmark.rb')
-rw-r--r-- | lib/benchmark.rb | 3 |
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 |