青木です。

  In mail "[ruby-reference-manual:74] Re: 作業マニュアル #1 (フォーマット変換)"
  Kazuhiro NISHIYAMA <zn@m...> wrote:

> 西山和広です。

> > > Structはどうなりますか?
> > 
> > 困ってるところです。
> 
> 他にクラスを返すメソッドというと、DelegateClassも
> ありますが、どうでしょうか?

DelegateClass は特にメソッドの記述が必要にならないので、
おそらく大丈夫だと思います。Struct は特異メソッドを追加
してくれるのがヒジョーに困りますね。

利便性を考えると、単に Struct にドキュメントをくっつけて、
「このメソッドは Struct のサブクラスに定義されてる」と
書いておけばよいかもしれません。


> > > RD方式だと別々のVerbatimにしたいと思ったら
> > > 間にVerbatim以外を挟むかインデントを下げて
> > > いかないといけないという問題があります。
> > 
> > そういうドキュメントは書くべきではないので、問題だとは思いません。
> 
> そういうドキュメントというのは
> 
>   Verbatim
> 
>   別のVerbatim
> 
> というドキュメントでしょうか?

こっちです。


> > また、どうしても連続して書きたければ //emlist を使えば回避でき
> > ます。
> 
> 連続してというのは、別々のVerbatimを連続して、でしょうか?
> それとも、空行を含む連続したVerbatimでしょうか?

別々の verbatim です。


> > > > === ハイパーリンク

> > 嬉しくないなら記述を長くしておいたほうがよいと思うので、
> > 現状でよいでしょう。
> 
> 「url:」必須の方がつけ忘れの可能性が出てうれしくないと
> 思います。
> そもそもリファレンスマニュアルから外部リンクは
> あまりつけるべきではないと言うことで長くなっているのなら、
> 「url:」必須のままで良いと思います。

後者だと思うので、とりあえず現状で。

--
青木峰郎

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