青木です。

いくつかファイルをチェックしていて、間違えられやすい表記が
わかってきたので、ここで確認します。


(1) 関数風メソッドの追加定義

標準添付ライブラリで関数風メソッド (例えば parseArgs) を
追加しているときは、以下のように記述してください。

  = reopen Kernel
  == Private Instance Methods
  --- parseArgs(....)

最初の「= reopen Kernel」を抜かしたり、Private を抜かしたりする
ケースが散見されました。


(2) require を記述すべきとき

ライブラリ先頭の require は、「このライブラリを requireしたら、
同時に使えると期待していいライブラリ」を記述するために使います。
例えば、webrick を require したら webrick/httprequest が
使えることは期待していいので、ドキュメントにも

  require webrick/httprequest

と書きます。

しかし、webrick を require したからと言って socket.so や
time.rb が使えることは期待すべきではないので、ドキュメントに
「require socket」や「require time」を記述すべきではありません。


(3) require の文法

ライブラリファイルの require には裸のライブラリ名を書いてください。
Ruby の文字列を書いてはいけません。

  正： require time
  誤： require 'time'
  誤： require "time"


(4) ドキュメントのヘッドライン

ライブラリ、クラス、メソッド、いずれのドキュメントについても、
ヘッドライン (見出し) を記述するときは「===」以上を使ってください。
「=」と「==」は BitClust システムが予約しています。

--
青木峰郎

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