Merge pull request #25 from nithinbekal/benchmark-realtime-docs

Improve docs for Benchmark.realtime
ruby · Sep 27, 2024 · c053675 · c053675
2 parents 0652906 + 0f278be
commit c053675
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/benchmark.rb b/lib/benchmark.rb
@@ -307,6 +307,10 @@ def measure(label = "") # :yield:
 
   #
   # Returns the elapsed real time used to execute the given block.
+  # The unit of time is seconds.
+  #
+  #       Benchmark.realtime { "a" * 1_000_000_000 }
+  #       #=> 0.5098029999935534
   #
   def realtime # :yield:
     r0 = Process.clock_gettime(Process::CLOCK_MONOTONIC)