Bug #4726: [doc] benchmark.rb

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: 1.9.3
• ruby -v: bf98fcefe1a9012731a351cb7c7cda74ae85e9ef

[sz (Sandor Szücs)]

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.

[drbrain (Eric Hodel)]

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

[mame (Yusuke Endoh)]

• 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 [e-mail]

[Eregon (Benoit Daloze)]

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 [e-mail]

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.

[drbrain (Eric Hodel)]

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

[drbrain (Eric Hodel)]

If the details of the yielded object are a specification we should document them, but the benchmark maintainer needs to agree first.