From: Tadashi Saito <redmine@...>
Date: 2010-04-01T00:03:55+09:00
Subject: [ruby-dev:40881] [Bug #3064] TypedDataについてのドキュメントがない

Bug #3064: TypedDataについてのドキュメントがない
http://redmine.ruby-lang.org/issues/show/3064

起票者: Tadashi Saito
ステータス: Open, 優先度: Normal
Target version: 1.9.2
ruby -v: ruby 1.9.2dev (2010-03-31 trunk 26808) [i686-linux]

斎藤と申します。拡張ライブラリの作者・librubyの1ユーザーです。

1.9.2で導入される予定のTypedDataについてのドキュメントが、まったく
ない事で困っています。具体的には、README.EXT{,.ja}に追記がなされ
ないと、拡張ライブラリ作者(つまり今の自分)としては

・今までのDataとの違いはなんだろう?
・今までのDataのAPIはobsoleteなんだろうか?
・それとも新しいTypedDataは内部向けで触っていけないものだろうか?

という疑問がたくさん沸いてきて、DataとTypedDataの使い分けをしようにも
どちらをどう触ってよいのか分かりません。そのあたりを、README.EXTに
書いていただきたいです。

自分がドキュメントを書くことにやぶさかではないのですが、導入の動機や
これから拡張ライブラリを作る人にどういう扱いをして欲しいかという
大事な点が分かっていないので、ささださんにぜひ導入者として責任を持って
書いていただきたいです。(もしささださん以外にTypedDataをよく分かって
いる方がいるならば、もちろんどなたでも構いません)

もっと具体的には、README.EXTの3.3「CのデータをRubyオブジェクトにする」
あたりの次と、Appendix B.の「** Cデータのカプセル化」の項などについて、
TypedDataの場合を追記して欲しいです。もちろん外部に使って欲しくなくて
「触るなキケン」ならば、その旨だけ書けば、詳細はいらないと思います。

加えて、TypedData新設の動機・メリットを示す形で、NEWSにも書いて欲しいです。


----------------------------------------
http://redmine.ruby-lang.org