メソッドにブロックが渡されなかった場合の説明を改善したい
pofkuma opened this issue · comments
ブロックを渡せるメソッドにブロックが渡されなかった場合の説明で、矛盾していると思われるものがいくつかありました。
-
Array#filter
https://docs.ruby-lang.org/ja/latest/method/Array/i/filter.htmlブロックを省略した場合は、各要素に対しブロックを評価し真になった値の配列を返すような Enumerator を返します。
-
Array#collect
https://docs.ruby-lang.org/ja/latest/method/Array/i/collect.htmlブロックを省略した場合、上で説明した繰り返しを実行し、その結果として得られる配列を返すような Enumerator オブジェクトを返します。
上記のような説明は混乱を招きそうなので改善したいと考えました。
ブロックが無いのにブロックで処理されるかのように記述されている部分は、削除するのが良さそうです。
参考）
-
Enumerable#max_by
https://docs.ruby-lang.org/ja/latest/method/Enumerable/i/max_by.htmlブロックを省略した場合は Enumerator を返します。
-
RDoc の記述
複数のメソッドの説明をざっと見たところ、次の２パターンがあるようでした。- サンプルコードがある場合
Returns a new Enumerator if no block given:
- サンプルコードがない場合
If no block is given, an Enumerator is returned instead.
- サンプルコードがある場合