From: TAKAHASHI Masayoshi <maki@...>
Date: 1999-11-03T20:33:27+09:00
Subject: [ruby-list:18346] Re: Ruby Library Manual

高橋征義です。

Hiroshi IGARASHI <igarashi@ueda.info.waseda.ac.jp>さん：
> なんかrubyapiの存在がドキュメント整備の停滞の
> 原因になってしまっているので、罪滅ぼしということで。

おお、すばらしいです。

> rubyapiはとりあえず忘れて^_^;;  RDで書いていきましょうか。
> 形式がそろわないかも知れませんが、ないよりいいということで。

何にしろ、「ほんとは両方必要」、ということになるのではないで
しょうか。つまり、

・おおよその使い方について書かれたもの。究極的には詳細なチュート
  リアルみたいになる。
・各クラス・モジュール・メソッドなどの詳細について書かれたもの。
  究極的にはリファレンスマニュアルみたいになる。

の二つが必要で、前者はドキュメント主体のRD、後者は構造が整理された
ものであって、機械的な加工処理に強いrubyapiが向いているんじゃないかと。

もちろん、内容的に重複する部分はありますから、両方に書かれる
部分があるのは避けられないですよね。

なので、RDによるドキュメントもどんどん進めていいと思います。また、

> # 個人的にはrubyapi的な方向でもあれこれ試してみるつもりですけど。

の方もがんばってください(^^;

> これもRuby/GTK Tutorialの英訳のように、
> ここで名乗り上げて分担していったらいいんでしょうか。
> 問題は誰がそれをまとめるかですが……

というか、どの程度のものからはじめますか？

ちょっと English.rb のRDを書きかけたのですが、まとめると、


=begin

== English.rb

=== Usage

  require 'English.rb'

  # for tab-separated file
  $FS = $OFS = "\t"

  # get date value
  /^Date:/ =~ $_
  date_value =  $POSTMATCH

=== Description

Aliases of Pre-defined Variables('$' + symbol).

機能的には記号を使った変数のものと同じ。

=== Version

???

=== Author

???

=== Copyright

(C) 199? ???

=end


こんな感じでいいんでしょうか？  足りないですか？

# English.rb の特殊事情ではありますが、各シンボルとの対応表を
# つけるとソースそのものになってしまいます(^^;

高橋征義 (TAKAHASHI Masayoshi)       Email:maki@inac.co.jp