Issue #6989 has been reported by sho-h (Sho Hashimoto).

----------------------------------------
Feature #6989: Array#sample などのメソッドシグネチャ

https://bugs.ruby-lang.org/issues/6989

Author: sho-h (Sho Hashimoto)
Status: Open
Priority: Normal
Assignee: sho-h (Sho Hashimoto)
Category: 
Target version: 
reporter: 
ruby_version: 


Array#sample などのメソッドについて、引数の random: rng の部分を修正しようかと考えています。

メソッドシグネチャについては、Array#shuffle と同様としようかと考えています。以下ですね。

  --- sample(random: rng) -> object | nil

@param についてはこの場合は @param rng としようかと考えています。

Array#sample は r5369 現在、--- sample(opts) のようなメソッドシグネチャにしていますが、上記であれば @param opts にするより簡潔になります。複数ある場合は分ける事もできます。また、キーにはシンボルを指定する事になるのは自明のため、わざわざ説明する必要もないのではないかと考えました。

これ以外の表記にする場合は bitclust も含めて修正しようかと思います。

他の表記をご希望の方いらっしゃいますか？なければ上記として Wiki と 既存のエントリの修正を行おうかと思います。



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

--
ML: ruby-reference-manual@m...
Info: http://QuickML.com/