Bug #4726

[doc] benchmark.rb

Added by Sandor Szücs almost 3 years ago. Updated almost 3 years ago.

[ruby-core:36274]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:1.9.3
ruby -v:bf98fcefe1a9012731a351cb7c7cda74ae85e9ef Backport:

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.

0001-removed-nodoc-because-the-most-is-documented.patch Magnifier - remove :nodoc: (1.46 KB) Sandor Szücs, 05/18/2011 01:46 AM

Associated revisions

Revision 31620
Added by Eric Hodel almost 3 years ago

  • lib/benchmark.rb: Remove nodoc from Benchmark::Job and Benchmark::Report. Patch by Sandor Szücs. [Ruby 1.9 - Bug #4726]

Revision 31729
Added by Eric Hodel almost 3 years ago

  • lib/benchmark.rb: Restore nodoc for Benchmark::Job and Benchmark::Report. [Ruby 1.9 - Bug #4726]

History

#1 Updated by Eric Hodel almost 3 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]

#2 Updated by Yusuke Endoh almost 3 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

#3 Updated by Benoit Daloze almost 3 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.

#4 Updated by Eric Hodel almost 3 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]

#5 Updated by Eric Hodel almost 3 years ago

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

Also available in: Atom PDF