ruby-list

師星です。
立て込んでいてメールを読まなかったらすっかりおいていかれてしまいましたが、
いま読み終えたところです。

特にふなばさんの

From: Tadayoshi Funaba <tadf@kt.rim.or.jp>
Subject: [ruby-list:24451] Re: Ruby DocumentationProject(仮)

> 僕は、今のところ、Date#day でなく、ただ day としたいと思っています。
> Date#day と書きたくないし、見せたくないし、見たくない、です。

以下のメールを、うん、そうそう、と思いながら読んでいました。
私の感じていた違和感をふなばさんに明確に表現された感じです。

私が思うに、RDのRDたる所以は書くのも読むのも人間優先ということで、
そこがフォーマッタなどのプロセシングを前提としたものと大きく違うところで
すよね。なるべくプレインテキストでそのまま印刷するものを書くのと同じに書
きたいと思うわけです。その点では、Toshさんの

From: Toshiro Kuwabara <toshirok@yb3.so-net.ne.jp>
Subject: [ruby-list:24554] Re: RubyDocumentationProject(仮)
Date: Sun, 27 Aug 2000 15:23:26 +0900

> 僕はRDというのはあくまで手で書くのに都合のいい様に考えられた
> フォーマットでおおざっぱに書けば細かい所は良きにはからってく
> れる(フォーマッタとか読者とかが)ものと考えていたので、RDに細

というのに近いです。

なので、RDindexのようにメタデータのデータソースをRDに求めるのなら
もっと賢く読んでよ、と思うわけで、そのために人間が嬉しくないと思う
記法を要求するのは違うんじゃないかなと感じます。

現在MethodListをめぐっての問題点はフォーマッタ(フォーマットとラベル付け)
とインデキシング(RDindex)の2つあるのだと思いますが、
フォーマッタに関する要求の発生は自然なものだと思うのですが、そのため
の構文(だけ)にメタデータを求めるのは無謀だと思います。

From: Koji Arai <JCA02266@nifty.ne.jp>
Subject: [ruby-list:24518] Re: RubyDocumentationProject(仮)

> トとしてまとまったドキュメントをあつめた場合、最終的に統一さ
> れた書き方で書くことによって、「付加機能」をつけたい(メソッ
> ドのindexingとか)。クラス名を書くのはそのための「慣習」を用
> 意したつもりです。

のところで違った方向へ進み始めたような気がします。
以下、こうしたらどうかなと私が思うことを交えますと、

> (1) RD で --- (MethodList)は削除！

---というプレフィクスが好きな人がいれば存続してもいいですが、後述の
'::'と同等ということでobsoleteにするのがいいかなと思います。

> (2) 見出しの中の一部の語だけをラベルとみなす構文を用意する
> 
> : ((<method>))(arg1, arg2)
> 
>  ((<>)) の中だけをラベルとみなす。

*Listやheadline(でしたっけ?)に、rubyのメソッドとして扱ってくれるような修
飾を導入する。
例えば DescListで ':' ではなく '::' というプレフィクスにするとか。
headlineでは'===:'でしょうか…。ItemListも'*:'だとメソッドないしは
識別子(変数とか)としてフォーマットしてくれてもいいような。

> (3) その上で RDの wrapper を用意する。以下のような書式をRDに変換する。

RDで書かれる文書の、クラス/モジュール/関数に関する「定型」を定める。
変換を前提とするマクロよりも、人間がそのまま読み書きする文書の「定型」と
いう扱いの方が良いのではないでしょうか
(言語ごとに変わってしまうかも知れないけど)。
少なくともRDPのような場合は定型を決めても構いませんよね。
=== クラスメソッド
のようなブロックの中にいない場合は Klass#method のような記法を元に判断す
れば、メソッドの種類ごとに分けたくないという人にも対応できそうです。

引用は省略してしまいましたが、新井さんの例はそのまま読める許容範囲かなと
思います。manのマクロはちょっとやだなと私は思います。

インデクサにはこれをもとにコンテクストを把握して処理してほしいです。RDに
おいては、インデクサがコンテクストを無視してシンタックスだけで処理できる
と思うのは乱暴ではないでしょうか。

以前のRDの話を追い掛けてなかったのでちょっと気が引けるのですが、私はこう
思いました。どうでしょう。

 - moro.

Thread

Prev Next

In This Thread

Prev Next

[#24065] Perl/Ruby Conference in Kyoto — Noritsugu Nakamura <nnakamur@...>

[#24068] continuation in thread — Takaaki Tateishi <ttate@...>

[#24070] 謎の Segmentation fault — YASUI Kentarow <kenyasui@...>

[#24073] Ruby で使える XML パーザーについて — Takaharu Yamashita <takayan@...2.so-net.ne.jp>

[#24082] Array#assoc — Kazuhiro NISHIYAMA <zn@...>

[#24086] // は偽？ — rubikitch <rubikitch@...>

[#24088] mod_ruby-0.1.8 and postgres-0.6.1 — Teruki Shigitani <shigi@...>

[#24095] p <obj> の返値 — ARIMA Yasuhiro <fit0298@...>

[#24102] Perl/Ruby Conference 開催決定 ! — matz@... (Yukihiro Matsumoto)

[#24109] gtk+ なクラスブラウザ — kadu <kadu3@...16.alpha-net.ne.jp>

[#24112] ある method がどこで def されたか調べる方法 — Yasushi Shoji <yashi@...>

[#24123] CGI::pretty — Kazuhiro NISHIYAMA <zn@...>

[#24125] rbcw145.zip に lib/net/telnet.rb がない — Kazuhiro NISHIYAMA <zn@...>

[#24126] embedded Ruby for Verilog — "Kikutani, Makoto" <kikutani@...>

[#24134] File.rename error message — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#24149] methods — Kazuhiro NISHIYAMA <zn@...>

[#24156] 改行コードが… — Hagemu Higuchi <hahiguc@...11.odn.ne.jp>

[#24158] Hash の初期値に [] を使う — Mitsuhiro Kondo <kondo@...>

[#24174] ruby によるバグ追跡システム — 堀川 久 <vzw00011@...>

[#24176] FreeBSD ports — "Akinori -Aki- MUSHA" <knu@...>

[#24186] media watch 2000.08.08 — Noritsugu Nakamura <nnakamur@...>

[#24191] drb.rb: 0x40155740 is recycled object (IndexError) — Hideto ISHIBASHI <hideto-i@...4u.or.jp>

[#24193] FreeBSD ports #2 — "Akinori -Aki- MUSHA" <knu@...>

[#24195] HTML 関連ライブラリ — MoonWolf <moonwolf@...>

[#24206] iconv 0.4.2 pre3 — nobu.nakada@...

[#24210] install guide — gotoken@... (GOTO Kentaro)

[#24222] FreeBSD ports #3 — "Akinori -Aki- MUSHA" <knu@...>

[#24226] Ruby で日本語とスペイン語の混在文は？ — Kakuzi TAKAHASI <ktaka@...>

[#24230] Ruby 1.4.6 repacked — matz@...

[#24249] no oper in %Ruby — Shugo Maeda <shugo@...>

[#24250] コマンドの STDERR への出力を補足したい。 — Kengo Nakajima <ringo@...>

[#24255] DBM failed on cygwin version — Ataru NAKATA <anakata@...>

[#24257] デバッグ用にデータをダンプしたい — Mitsuhiro Kondo <kondo@...>

[#24259] RDindex 1.1.0 — rubikitch <rubikitch@...>

[#24261] — Shigeki Shiroshima <pakshima@...>

[#24267] What's the biggest Ruby development? — Dave Thomas <Dave@...>

[#24268] はじめまして & cygwinでconfigure不能 — "Mitsuo Igarashi" <mitsu5@...>

[#24270] 1.4.6 cgi-lib — Masatoshi SEKI <m_seki@...>

[#24271] Tiki, ruby-1.4.6 — Masatoshi SEKI <m_seki@...>

[#24272] How to read buffered data? — Tanaka Akira <akr@...17n.org>

[#24274] About sub with multilines — kiri@...

[#24280] RE: [ruby-list:24268] cygwinでconfigure不能:cygwin1.dllの問題 — "Mitsuo Igarashi" <mitsu5@...>

[#24284] 拡張ライブラリ作成時の NULL ポインター — Akimichi Tatsukawa <akimichi@...>

[#24291] media watch 2000.08.18 — Noritsugu Nakamura <nnakamur@...>

[#24294] grep(!/hoge/)? — kiri@...

[#24298] Re: cygwin で configure 不能 :cygwin1.dll の問題 — "Mitsuo Igarashi" <mitsu5@...>

[#24299] Where MDArray? — kiri@...

[#24305] Status: header and cgi.rb — Yasuhiro Fukuma <yasuf@...>

[#24314] はじめまして ...? — polygon <kiyose@...>

[#24316] 画像のサイズを調べるスクリプト — kadu <kadu3@...16.alpha-net.ne.jp>

[#24317] undefined cygwin_dll_entry — polygon <kiyose@...>

[#24321] shttpsrv — TAKAHASHI Masayoshi <maki@...>

[#24323] HP-UX 上での ruby1.4.6 make getaddrinfo.c err — yasuaki onishi <yasuaki@...4u.or.jp>

[#24324] ruby の発展の為に — "Mitsuo Igarashi" <mitsu5@...>

[#24329] Coerce between Range and Boolean — NISHIKAWA <nyasu@...3web.ne.jp>

[#24341] install guide draft — gotoken@... (GOTO Kentaro)

[#24357] FreeBSD ports #4 — "Akinori -Aki- MUSHA" <knu@...>

[#24378] bin package on win/dos — Noritsugu Nakamura <nnakamur@...>

[#24384] erb-1.3.1 — Masatoshi SEKI <m_seki@...>

[#24399] 「 Ruby プログラミング入門」査読者募集 — Shin-ichiro Hara <sinara@...>

[#24430] (RDP) Engurish ftools.rd — gotoken@... (GOTO Kentaro)

[#24439] HotLinks — NISHIKAWA <nyasu@...3web.ne.jp>

[#24447] (RDP) tempfile.rd — Toshiro Kuwabara <toshirok@...3.so-net.ne.jp>

[#24464] Tips for Perl -> Ruby — kiri@...

[#24469] レンタルサーバで eruby — Tokita Kousui <ktokita@...>

[#24473] RD for(?) Cygwin — polygon <kiyose@...>

[#24491] Re: レンタルサーバで eruby — "Kahori Takeuchi" <EB89012@...>

[#24499] FreeBSD port: x11-toolkits/rubytk — Yasuhiro Fukuma <yasuf@...>

[#24501] media watch 2000.08.24 — Noritsugu Nakamura <nnakamur@...>

[#24515] MSWin Ruby on Windows2000 — arton <arton@...>

[#24520] wildcard arg for ruby1.4 — arton <arton@...>

[#24522] (RDP) readline — Koji Arai <JCA02266@...>

[#24531] RD 質問 — Koji Arai <JCA02266@...>

[#24550] Array への nil の代入について — Kenya Ogata <k_ogata@...>

[#24556] 埋め込みドキュメント仕様 RubyDoc( 提案) — MoonWolf <moonwolf@...>

[#24559] 配列内のオブジェクトの配列内のオブジェクトの関数 — Yasuki <yasuki@...>

[#24565] Ruby FAQ — Kazuhiro NISHIYAMA <zn@...>

[#24592] perl to ruby — "Yasuyuki Imai" <waver@...3.ttcn.ne.jp>

[#24625] member list was crashed — matz@... (Yukihiro Matsumoto)

[#24631] Re: RubyDocumentationProject( 仮 ) — TAKAHASHI Masayoshi <maki@...>

[#24174] ruby によるバグ追跡システム — 堀川　久 <vzw00011@...>