Bug #470

File::openのドキュメント

Added by yugui (Yuki Sonoda) almost 4 years ago. Updated about 1 year ago.

[ruby-dev:35915]
Status:Closed Start date:08/22/2008
Priority:Normal Due date:12/24/2008
Assignee:yugui (Yuki Sonoda) % Done:

0%
Category:DOC
Target version:1.9.1 Release Candidate
ruby -v:

Description

現状ではFile::openの挙動をrdocから読み取ることが困難です。

1. IO::openの解説に、サブクラスでIO#initializeをオーバーライドした場合に引数を含めて挙動が左右されることが書かれていない
2. IO::openの解説にIO#initializeに依存した引数の仕様だけが書いてある

各クラスのクラスメソッドnewの解説に倣うならば、IO::openの解説とは別にFile::openのエントリが存在すべきです。

添付(redmineに)のパッチではrdocはFile::openというエントリを認識してくれませんでした。どうも、RDoc::Parser::Cは、このようなRubyインスタンスを通じてC言語関数が多態性を持つ可能性を考慮せず、1つのrb_define_methodについて1つのエントリを作成するように思えます。

file-open.diff (1.4 kB) yugui (Yuki Sonoda), 08/22/2008 09:57 pm

Related issues

precedes ruby-trunk - Bug #901: RDoc does not handle multiple method description for a C ... Closed 12/25/2008 01/01/2009

History

#1
Updated by ko1 (Koichi Sasada) over 3 years ago

  • Assignee set to matz (Yukihiro Matsumoto)

#2
Updated by yugui (Yuki Sonoda) over 3 years ago

  • Assignee deleted (matz (Yukihiro Matsumoto))
  • Target version set to 1.9.1 Release Candidate

#3
Updated by ko1 (Koichi Sasada) over 3 years ago

  • Assignee set to matz (Yukihiro Matsumoto)

#4
Updated by yugui (Yuki Sonoda) over 3 years ago

  • Assignee changed from matz (Yukihiro Matsumoto) to yugui (Yuki Sonoda)
call-seq二つじゃなくて、並べて書けば、とのこと。

#5
Updated by yugui (Yuki Sonoda) over 3 years ago

  • Due date set to 12/24/2008

#6
Updated by yugui (Yuki Sonoda) over 3 years ago

  • Status changed from Open to Closed
applied in r20946.

Also available in: Atom PDF