Project

General

Profile

Bug #6533

Benchmark documenation formatting bug and consistency

Added by zzak (Zachary Scott) over 8 years ago. Updated over 8 years ago.

Status:
Closed
Priority:
Normal
Target version:
ruby -v:
2.0.0
Backport:
[ruby-core:45385]

Description

=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


Files

Updated by drbrain (Eric Hodel) over 8 years ago

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

Updated by zzak (Zachary Scott) over 8 years ago

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

Thanks for your feedback!

#3

Updated by drbrain (Eric Hodel) over 8 years ago

  • 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]

Updated by drbrain (Eric Hodel) over 8 years ago

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.

Also available in: Atom PDF