kouyaです。

2013年2月5日 19:18 pypypy567 (py _) <redmine@r...>:
>
> Issue #7769 has been updated by pypypy567 (py _).
>
>
> 使用例についてはあちこち編集してるうちになんとなくこうなっただけなので強い意見は有りません。
> Random#rand のもばっさり削って代わりに Kernel.#rand との違いを説明する例を増やしてもよいかもしれません。
> Array#sample などの影響を受けないこととか。

はい、Random ライブラリの意義がわかりやすくなると思うので、良いと思います。

>
>
> 例外については僕も元々はそんな感じに考えてたのですが、
> 青木さんのメールを読んでからは、メソッド中で明示的に raise している例外を書くというのはあくまで「面倒だったらこの程度の判断基準でいいよ」という指針だと考えています。
>

下記を読みました。
http://www.fdiary.net/ml/ruby-reference-manual/msg/334

私になりにまとめると、（間違っていたら修正よろしく）
基本的に発生する例外はすべて書く。
しかし、ArgumentError, TypeError等の@param などの記述をみれば自明であるような例外は
リファレンスを書く段階では、数が多い、例外を追い切れない、@paramに詳細に記述してあるなどの理由で面倒だったら書かなくても良い。
ただし、積極的に今書いてあるArgumentError やTypeErrorは消す必要は無い。
もし、本当にいらないならbitclust等のツールで@raise
を識別してArgumentErrorやTypeErrorをHTML等の最終生成物では消すことができる。

こんな感じですかね。

私の個人的なリファレンス使用傾向だと、@paramの記述が２行以上だと全部の記述をちゃんと読まないことが多く、よって@raise
のように独立した部分に分けて書いてあると、ちゃんと読む確率が上がるのでTypeErrorでもArgumentError
でもあった方がうれしいですが(^^;)


-- 
kouya

--
ML: ruby-reference-manual@m...
使い方: http://QuickML.com/