Bug #4726
closed[doc] benchmark.rb
Description
Maybe you find it not useful, but to open up internals it would be nice to print internal docs.
This patch just removes :nodoc: comments.
Files
Updated by drbrain (Eric Hodel) over 13 years ago
- Status changed from Open to Closed
- % Done changed from 0 to 100
This issue was solved with changeset r31620.
Sandor, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.
- lib/benchmark.rb: Remove nodoc from Benchmark::Job and
Benchmark::Report. Patch by Sandor Szücs. [Ruby 1.9 - Bug #4726]
Updated by mame (Yusuke Endoh) over 13 years ago
- Status changed from Closed to Open
Hello,
Maybe you find it not useful, but to open up internals it would be nice to print internal docs.
Why do you want to open internal?
Generally, I don't think it is a good idea.
It limits future potential.
--
Yusuke Endoh mame@tsg.ne.jp
Updated by Eregon (Benoit Daloze) over 13 years ago
Hello,
Yusuke Endoh wrote:
Hello,
Maybe you find it not useful, but to open up internals it would be nice to print internal docs.
Why do you want to open internal?
Generally, I don't think it is a good idea.
It limits future potential.--
Yusuke Endoh mame@tsg.ne.jp
I must agree, opening the internals would make harder sensible internal changes.
However, with :nodoc:, it is unclear which methods are available on the yielded object in Benchmark#{benchmark,bm,bmbm}.
(that is probably why I never saw anyone using #item, to which #report is an alias)
Thank you for pointing this out, but I would prefer to keep the internals undocumented to the end user for the moment.
Updated by drbrain (Eric Hodel) over 13 years ago
- Status changed from Open to Closed
This issue was solved with changeset r31729.
Sandor, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.
- lib/benchmark.rb: Restore nodoc for Benchmark::Job and
Benchmark::Report. [Ruby 1.9 - Bug #4726]
Updated by drbrain (Eric Hodel) over 13 years ago
If the details of the yielded object are a specification we should document them, but the benchmark maintainer needs to agree first.