Bug #3545: []による引数の省略
http://redmine.ruby-lang.org/issues/show/3545

起票者: Kazuhiro NISHIYAMA
ステータス: Open, 優先度: Normal
担当者: Kazuhiro NISHIYAMA, カテゴリ: doc

http://redmine.ruby-lang.org/wiki/rurema/HowToWriteMethodEntry
で「メソッドシグネチャは Ruby での def と同じように記述します。」となっているので、
meth([str]) のように [] で省略を表記しているところを減らすようにしてみました。
「git grep '^--- ..*[[].*->'」でおおまかに探しただけなので、全部ではないと思います。
数日待ってみて、問題なさそうならコミットする予定です。

diff --git a/refm/api/src/_builtin/functions b/refm/api/src/_builtin/functions
index d43a2ba..df47f0f 100644
--- a/refm/api/src/_builtin/functions
+++ b/refm/api/src/_builtin/functions
@@ -1737,7 +1737,8 @@ at_exit
   
   puts "end on #{try(400)}" #=> end on ???
 
---- sleep([sec]) -> Integer
+--- sleep -> Integer
+--- sleep(sec) -> Integer
 
 sec 秒だけプログラムの実行を停止します。
 
diff --git a/refm/api/src/jcode.rd b/refm/api/src/jcode.rd
index a25c7cd..9c281c6 100644
--- a/refm/api/src/jcode.rd
+++ b/refm/api/src/jcode.rd
@@ -218,8 +218,8 @@ self 
   p zstr.delete("Ａ")  # => "ＢＣＤＥＦ"
   p hoge.delete("e")   # => "hoghog"
     
---- squeeze([str]) -> String
---- squeeze!([str]) -> String|nil
+--- squeeze(str = nil) -> String
+--- squeeze!(str = nil) -> String|nil
 
 [[m:String#squeeze]] の日本語対応版です。
 指定した文字を1文字にまとめます。
diff --git a/refm/api/src/net/http.rd b/refm/api/src/net/http.rd
index acb5fde..992fe7f 100644
--- a/refm/api/src/net/http.rd
+++ b/refm/api/src/net/http.rd
@@ -862,8 +862,8 @@ HTTP 
 
 @see [[m:Net::HTTP#request]]
 
---- request(request [, data]) -> Net::HTTPResponse
---- request(request [, data]) {|response| .... } -> Net::HTTPResponse
+--- request(request, data = nil) -> Net::HTTPResponse
+--- request(request, data = nil) {|response| .... } -> Net::HTTPResponse
 
 [[c:Net::HTTPRequest]] オブジェクト request をサーバに送信します。
 
diff --git a/refm/api/src/socket/Socket b/refm/api/src/socket/Socket
index 3e2918b..79ee9eb 100644
--- a/refm/api/src/socket/Socket
+++ b/refm/api/src/socket/Socket
@@ -45,7 +45,7 @@ Stevens 
 #@# ファイルディスクリプタ fd に対する新しいソケットを生成します。
 #@# #@end
 
---- getaddrinfo(nodename, servname[, family[, socktype[, protocol[, flags]]]]) -> Array
+--- getaddrinfo(nodename, servname, family=nil, socktype=nil, protocol=nil, flags=nil) -> Array
 #@todo
 
 [[RFC:2553]]で定義された
diff --git a/refm/api/src/socket/TCPServer b/refm/api/src/socket/TCPServer
index 1ab155d..40d681b 100644
--- a/refm/api/src/socket/TCPServer
+++ b/refm/api/src/socket/TCPServer
@@ -56,8 +56,8 @@ Thread 
 
 == Class Methods
 
---- new([host, ]service) -> TCPServer
---- open([host, ]service) -> TCPServer
+--- new(host=nil, service) -> TCPServer
+--- open(host=nil, service) -> TCPServer
 
 新しいサーバー接続をオープンします。service は
 /etc/services (または NIS) に登録されているサービ
diff --git a/refm/api/src/socket/TCPSocket b/refm/api/src/socket/TCPSocket
index d3d2175..987e6d8 100644
--- a/refm/api/src/socket/TCPSocket
+++ b/refm/api/src/socket/TCPSocket
@@ -23,8 +23,8 @@
 
 == Class Methods
 
---- open(host, service [, local_host, local_service]) -> TCPSocket
---- new(host, service [, local_host, local_service]) -> TCPSocket
+--- open(host, service, local_host=nil, local_service=nil) -> TCPSocket
+--- new(host, service, local_host=nil, local_service=nil) -> TCPSocket
 #@todo
 
 host で指定したホストの service で指定したポートと接続したソケッ
diff --git a/refm/api/src/win32ole/WIN32OLE b/refm/api/src/win32ole/WIN32OLE
index 7f499c3..2caeefb 100644
--- a/refm/api/src/win32ole/WIN32OLE
+++ b/refm/api/src/win32ole/WIN32OLE
@@ -91,7 +91,7 @@ defined as CONSTANTS hash element.
    WIN32OLE.const_load('Microsoft Office 9.0 Object Library', MSO)
    puts MSO::MsoLineSingle # => 1
 
---- new(server, [host]) -> WIN32OLE object
+--- new(server, host=nil) -> WIN32OLE object
 #@todo
 
 Returns a new WIN32OLE object(OLE Automation object). The first
@@ -183,7 +183,7 @@ interface.
      cell.value = 10
    end
 
---- invoke(method, [arg1,...])  -> return value of method.
+--- invoke(method, *args)  -> return value of method.
 #@todo
 
 Runs OLE method. The first argument specifies the method name
@@ -194,7 +194,7 @@ method instead.
   excel = WIN32OLE.new('Excel.Application')
   excel.invoke('Quit')  # => same as excel.Quit
 
---- method_missing(id [,arg1, arg2, ...])
+--- method_missing(id, *args)
 #@todo
 
 Calls WIN32OLE#invoke method.
diff --git a/refm/api/src/win32ole/WIN32OLE_TYPELIB b/refm/api/src/win32ole/WIN32OLE_TYPELIB
index 6a5872f..2b2b7ed 100644
--- a/refm/api/src/win32ole/WIN32OLE_TYPELIB
+++ b/refm/api/src/win32ole/WIN32OLE_TYPELIB
@@ -3,7 +3,7 @@ WIN32OLE_TYPELIB objects represent OLE tyblib information.
 
 == Class Methods
 
---- new(typelib [, version1, version2]) -> WIN32OLE_TYPELIB object
+--- new(typelib, version1=nil, version2=nil) -> WIN32OLE_TYPELIB object
 #@todo
 
 Returns a new WIN32OLE_TYPELIB object.


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

--
ML: ruby-reference-manual@m...
使い方: http://QuickML.com/