Feature #4049

クラスリファレンスのメソッド名に、自動的にクラス名を付加してほしい

Added by kaorukobo (Kaoru Kobo) over 1 year ago. Updated 11 months ago.

[ruby-reference-manual:2528]
Status:Rejected Start date:11/13/2010
Priority:Normal Due date:
Assignee:- % Done:

0%

Category:bitclust
Target version:-
reporter: ruby_version:

Description

旧リファレンスマニュアルの頃に、
よく、例えば
「 IO.read (IO#readではなく) の説明にすぐ飛びたい」と思ったら
IOクラスのページへ行き、即ブラウザのページ内検索で、 "IO.re" を検索すればすぐそこへ飛べて便利でした。

例えば、
http://doc.ruby-lang.org/ja/1.9.2/class/IO.html
であれば、 IO.read の method-heading である

  read(path, opt = {}) -> String | nil

が自動的に

  IO.read(path, opt = {}) -> String | nil

というふうにクラス名+メソッドのタイプ(., #, .#) が表示されると嬉しいです。

History

Updated by kaorukobo (Kaoru Kobo) over 1 year ago

この要望についてですが、
もしこの機能を実現するパッチを書いて送れば、
取り入れていただくことができますでしょうか?

Updated by kouya (taifu kouya) over 1 year ago

kouyaです。

使い勝手の観点では、ブラウザのページ内部検索でIO.readとIO#readが識別できたら便利だと思います。
また、本リファレンスでは、使用例やSEE_ALSO等においても、すでにIO.read と IO#readの表記が多く出てきており、
いまさら記述が冗長になるということもないと思いますので、導入に賛成します。

で、パッチが取り込まれるかは、いまパッチがないのでよくわかりませんが、
いまのところ本件に反対する人がいないところをみると、多分、いけるんじゃないかな〜。


-- 
kouya

--
ML: ruby-reference-manual@ml.fdiary.net
使い方: http://QuickML.com/

Updated by kaorukobo (Kaoru Kobo) over 1 year ago

kouyaさんへ

メールを取り落としていて、お返事に気付きませんでした…。

賛成ありがとうございます。
もし時間が見つかれば、実装をしてみようかなと思います。

Updated by okkez (okkez _) about 1 year ago

今さらですが、一応反対しておきます。 そんなに使いやすくない上に長いクラス名がある場合に見栄えがすごく悪くなるので反対です。 そういう検索をしたいときはるりまサーチや refe 使うと便利だと思います。

Updated by okkez (okkez _) 11 months ago

  • Status changed from Open to Rejected
反応ないみたいなので Reject します。

Also available in: Atom PDF