Bug #6533: Benchmark documenation formatting bug and consistency

• Status: Closed
• Priority: Normal
• Assignee: drbrain (Eric Hodel)
• Target version: 2.0.0
• ruby -v: 2.0.0
• Backport: 2.3: UNKNOWN, 2.4: UNKNOWN, 2.5: UNKNOWN

[zzak (Zachary Scott)]

=begin
I've added a patch to fix a formatting bug with lib/benchmark.

(({BENCHMARK_VERSION = "2002-04-25" #:nodoc"})) should be (({BENCHMARK_VERSION = "2002-04-25" # :nodoc:}))

Also, went through and fixed up formatting for consistency.
=end

[drbrain (Eric Hodel)]

Can you drop the around GC.start on 214 like you did on 135 for Benchmark::Tms? This will let it link.

[zzak (Zachary Scott)]

• File 0002-Benchmark-documenation-formatting-bug-and-consistency.patch 0002-Benchmark-documenation-formatting-bug-and-consistency.patch added

Hi Eric,
I've added a new patch with the change you requested for GC.start

Thanks for your feedback!

[drbrain (Eric Hodel)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

This issue was solved with changeset r35974.
Zachary, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• lib/benchmark.rb: Updated formatting of Benchmark documentation for consistency. [ruby-trunk - Bug #6533]

[drbrain (Eric Hodel)]

I also stripped out the emphasis for the "Generates:" lines entirely since the ri looks better that way, and re-wrapped the comment for Benchmark#bm to fit 80 lines.