From: Benoit Daloze <redmine@...>
Date: 2011-05-25T07:46:31+09:00
Subject: [ruby-core:36441] [Ruby 1.9 - Bug #4726] [doc] benchmark.rb


Issue #4726 has been updated by 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 <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.
----------------------------------------
Bug #4726: [doc] benchmark.rb
http://redmine.ruby-lang.org/issues/4726

Author: Sandor Sz��cs
Status: Open
Priority: Normal
Assignee: Eric Hodel
Category: DOC
Target version: 1.9.3
ruby -v: bf98fcefe1a9012731a351cb7c7cda74ae85e9ef


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.


-- 
http://redmine.ruby-lang.org