From: matz@... (Yukihiro Matsumoto)
Date: 1998-10-09T14:59:39+09:00
Subject: [ruby-list:9936] Re: comments on manual (Re: man-1.1/Marshal.html)

まつもと ゆきひろです

In message "[ruby-list:9909] Re: comments on manual (Re: man-1.1/Marshal.html)"
    on 98/10/09, Motoyuki Kasahara <m-kasahr@sra.co.jp> writes:

|SRA の笠原です。

|ええと、では、いくつか気付いたことを書いてみました。
|何も貢献せずに指摘だけするように聞こえたら、ごめんない。

全然構いません．

|* IO クラスの `read [length]' メソッドの説明 (IO.html) ですが、「EOF
|  を読み込んだときは nil を返す」という記述が抜けています。

追加します．

|* 組み込みクラスのマニュアル全体に言えることですが、期待した動作が失敗
|  した場合、何が起こるのか、例外が起こるとしたらどういう例外なのか、の
|  記述がないようです。

そうですねえ．将来のリファレンス本のためにとっておいてある，
なんていうとちょっとアコギな印象を与えますかね．おいおい追加
してるんですが，こういうのは後回しになることが多くて．

Ruby本体と同じでどしどし指摘して下さると改善されてくと思いま
すです．

|* 指摘というわけではないのですが、添付ライブラリのドキュメントは、今後
|  整備されていく予定はあるのでしょうか?  `$(libdir)/ruby' の下に、いろ
|  いろと *.rb ファイルがあるのですが、どうもドキュメントが無いものが少
|  なくないようです。添付ライブラリと比較すると寂しいです。

これらも必要ですよね．私の書いたものはできるだけ簡単な(ちょっ
と簡単すぎるかも)説明をコメントとして追加してあるんですが．
整備される予定はともかく，整備される必要はあるでしょう．

                                まつもと ゆきひろ /:|)