高尾です。

>> On Sun, 22 Jun 2008 15:09:32 +0900
>> okkez <okkez000@g...> wrote:
>>> サンプルの説明で、 Kernel.#p なしで #=> を使っている場合がありますが、
>>> それは全部、 Kernel.#p 有りに統一するべきでしょうか？
>
> ただ、今後の実行例について、なんらかの方針があっても良いように思います。
> また、それをwikiに記述してあると良いように思います。
> # です、ます調も同じように思います。

ということで、以下のような修正案を考えました。
いかがでしょうか。

◯ですます調
http://doc.loveruby.net/wiki/ClassReferenceManualFormat.html
----- ここから -----
== 基本方針

クラスリファレンスのフォーマットは RD ベースです。
(ただし、厳密にパースできるように制限を増やしてあります。)

リファレンスはですます調で記述することを推奨します。

== ファイルの構造
(省略)
----- ここまで -----

◯xmpfilter
http://doc.loveruby.net/wiki/HowToWriteMethodEntry.html
----- ここから -----
(省略)
== メソッドのドキュメントでの規則
(省略)
#(省略可) その他の注意事項を書く。
#(省略可) 使用例を書く。実行結果を記述する場合、「# => <実行結果>」というようにxmpfilterの結果の記述を推奨。
#(省略可) 発生する例外を書く。 「@raise ArgumentError ...」などと書く。
(省略)
        "strstrstr".index(/str/)       # => 0      ← 引数 pattern の例
        "strstrstr".index("str")       # => 0
        "strstrstr".index(?s)          # => 0

        "strstrstr".index(/xxx/)       # => nil   ← 検索が失敗したときの例
        "strstrstr".index("xxx")       # => nil
        "strstrstr".index(?x)          # => nil

        "strstrstr".index(/str/, 0)    # => 0    ← pos 引数の例
        "strstrstr".index(/str/, 1)    # => 3
        "strstrstr".index(/str/, 3)    # => 3
        "strstrstr".index(/str/, 4)    # => 6

        "strstrstr".index(/str/, -1)   # => nil    ← 負の pos 引数の例
        "strstrstr".index(/str/, -2)   # => nil
        "strstrstr".index(/str/, -3)   # => 6
----- ここまで -----


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