From a7d3c9411065663cd9d0ac645f5c50393ca9e444 Mon Sep 17 00:00:00 2001 From: Richard Wardin Date: Wed, 5 Sep 2018 14:58:16 -0400 Subject: [PATCH] Work on Benchmark::Tms documentation --- lib/benchmark.rb | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/lib/benchmark.rb b/lib/benchmark.rb index 8d768b631e..f8ad866ec7 100644 --- a/lib/benchmark.rb +++ b/lib/benchmark.rb @@ -439,6 +439,9 @@ def add(&blk) # :yield: # # An in-place version of #add. + # Changes the times of this Tms object by making it the sum of the times + # for this Tms object, plus the time required to execute + # the code bloc (+blk+). # def add!(&blk) t = Benchmark.measure(&blk) @@ -452,7 +455,7 @@ def add!(&blk) # # Returns a new Tms object obtained by memberwise summation - # of the individual times for this Tms object with those of the other + # of the individual times for this Tms object with those of the +other+ # Tms object. # This method and #/() are useful for taking statistics. # @@ -460,20 +463,20 @@ def +(other); memberwise(:+, other) end # # Returns a new Tms object obtained by memberwise subtraction - # of the individual times for the other Tms object from those of this + # of the individual times for the +other+ Tms object from those of this # Tms object. # def -(other); memberwise(:-, other) end # # Returns a new Tms object obtained by memberwise multiplication - # of the individual times for this Tms object by _x_. + # of the individual times for this Tms object by +x+. # def *(x); memberwise(:*, x) end # # Returns a new Tms object obtained by memberwise division - # of the individual times for this Tms object by _x_. + # of the individual times for this Tms object by +x+. # This method and #+() are useful for taking statistics. # def /(x); memberwise(:/, x) end @@ -529,7 +532,7 @@ def to_a # # Returns a new Tms object obtained by memberwise operation +op+ # of the individual times for this Tms object with those of the other - # Tms object. + # Tms object (+x+). # # +op+ can be a mathematical operation such as +, -, # *, / -- 2.16.2