ruby-reference-manual:2047
From: Kazuhiro NISHIYAMA <redmine@r...>
Date: Thu, 25 Mar 2010 20:38:24 +0900
Subject: [ruby-reference-manual:2047] [Bug #3013] 「返り値の型の記述方法」の「代入式の場合には省略する。」
Bug #3013: 「返り値の型の記述方法」の「代入式の場合には省略する。」 http://redmine.ruby-lang.org/issues/show/3013 起票者: Kazuhiro NISHIYAMA ステータス: Open, 優先度: Normal 「返り値の型の記述方法」の「代入式の場合には省略する。」に従っていないところを直そうと思います。 少し待って問題なさそうならコミットする予定です。 % egrep -re '^---.*[^<=>!]=\(.*->' . ./refm/api/src/csv/CSV__Cell:--- data=(new_data) -> nil ./refm/api/src/csv/CSV__Cell:--- is_null=(new_data) -> nil ./refm/api/src/readline.rd:--- input=(input) -> File ./refm/api/src/readline.rd:--- output=(output) -> File ./refm/api/src/readline.rd:--- []=(index, string) -> String ./refm/api/src/curses.rd:--- ESCDELAY=(val) -> Integer ./refm/api/src/curses.rd:--- TABSIZE=(val) -> Integer ./refm/api/src/_builtin/Hash:--- []=(key, value) -> object ./refm/api/src/_builtin/IO:--- close_on_exec=(bool) -> bool ./refm/api/src/_builtin/ARGF:--- lineno=(number) -> nil ./refm/api/src/_builtin/ENV:--- []=(key, value) -> String ./refm/api/src/_builtin/Struct:--- []=(member, value) -> object ./refm/api/src/_builtin/String:--- []=(nth, val) -> val ./refm/api/src/_builtin/String:--- []=(nth, len, val) -> val ./refm/api/src/_builtin/String:--- []=(substr, val) -> val ./refm/api/src/_builtin/String:--- []=(regexp, nth = 0, val) -> () ./refm/api/src/_builtin/String:--- []=(regexp, val) -> () ./refm/api/src/_builtin/String:--- []=(range, val) -> val ./refm/api/src/_builtin/Encoding:--- default_external=(encoding) -> Encoding ./refm/api/src/_builtin/Encoding:--- default_internal=(encoding) -> Encoding ./refm/api/src/strscan.rd:--- pointer=(n) -> Fixnum ./refm/api/src/strscan.rd:--- pos=(n) -> Fixnum ./refm/api/src/strscan.rd:--- string=(str) -> String ./refm/api/src/webrick/cookie.rd:--- secure=(value) -> bool ./refm/api/src/net/http.rd:--- form_data=(params) -> () ./refm/api/src/socket/BasicSocket:--- do_not_reverse_lookup=(bool) -> bool ./refm/api/src/io/nonblock.rd:--- nonblock=(bool) -> Integer ./refm/api/src/gdbm.rd:--- fastmode=(bool) -> bool ./refm/api/src/gdbm.rd:--- syncmode=(bool) -> bool ./refm/api/src/yaml/store.rd:--- []=(name, value) -> object ./refm/api/src/zlib/GzipWriter:--- mtime=(time) -> Fixnum ./refm/api/src/zlib/GzipWriter:--- orig_name=(filename) -> String ./refm/api/src/zlib/GzipWriter:--- comment=(string) -> String ./refm/api/src/zlib/GzipReader:--- lineno=(num) -> Integer ./refm/api/src/zlib/ZStream:--- avail_out=(size) -> Integer % egrep -l -re '^---.*[^<=>!]=\(.*->' .|xargs perl -pli -e 's/^(---.*[^<=>!]=\(.*?)\s*->.*/$1/' % git diff diff --git a/refm/api/src/_builtin/ARGF b/refm/api/src/_builtin/ARGF index 7407d69..f9673c0 100644 --- a/refm/api/src/_builtin/ARGF +++ b/refm/api/src/_builtin/ARGF @@ -152,7 +152,7 @@ $stdin #=> [12, " age: 7\n"] #... ---- lineno=(number) -> nil +--- lineno=(number) 全引数ファイルを一つのファイルとみなしたときの現在の行番号をnumberに書き換えます @param number 更新後の行番号を指定する diff --git a/refm/api/src/_builtin/ENV b/refm/api/src/_builtin/ENV index 7aa20e4..abfa892 100644 --- a/refm/api/src/_builtin/ENV +++ b/refm/api/src/_builtin/ENV @@ -36,7 +36,7 @@ key @param key 環境変数名を指定します。 to_str で文字列化されます。 ---- []=(key, value) -> String +--- []=(key, value) --- store(key, value) -> String key に対応する環境変数の値を value にします。 diff --git a/refm/api/src/_builtin/Encoding b/refm/api/src/_builtin/Encoding index 9d0bcd6..947e420 100644 --- a/refm/api/src/_builtin/Encoding +++ b/refm/api/src/_builtin/Encoding @@ -84,13 +84,13 @@ default_external @see [[man:locale(1)]], [[m:Encoding.locale_charmap]] ---- default_external=(encoding) -> Encoding +--- default_external=(encoding) 規定の外部エンコーディングを設定します。 --- default_internal -> Encoding | nil 規定の内部エンコーディングを返します。 ---- default_internal=(encoding) -> Encoding +--- default_internal=(encoding) 規定の内部エンコーディングを設定します。 --- locale_charmap -> String | nil diff --git a/refm/api/src/_builtin/Hash b/refm/api/src/_builtin/Hash index e957670..dcb3770 100644 --- a/refm/api/src/_builtin/Hash +++ b/refm/api/src/_builtin/Hash @@ -433,7 +433,7 @@ fetch @see [[m:Hash#has_key?]] ---- []=(key, value) -> object +--- []=(key, value) --- store(key, value) -> object key に対して value を関連づけます。value を返し diff --git a/refm/api/src/_builtin/IO b/refm/api/src/_builtin/IO index c8ec636..0b14f15 100644 --- a/refm/api/src/_builtin/IO +++ b/refm/api/src/_builtin/IO @@ -1585,7 +1585,7 @@ back). Has no effect with unbuffered reads (such as <code>IO#sysread</code>). 自身がバイナリモードなら true を返します。そうでない場合、false を返します。 ---- close_on_exec=(bool) -> bool +--- close_on_exec=(bool) #@todo 自身に close-on-exec フラグを設定します。 diff --git a/refm/api/src/_builtin/String b/refm/api/src/_builtin/String index 6c821e1..7a2b748 100644 --- a/refm/api/src/_builtin/String +++ b/refm/api/src/_builtin/String @@ -605,7 +605,7 @@ range.first 'abcd'[-4 ... 2] # => "ab" 'abcd'[-5 ... 2] # => nil ---- []=(nth, val) -> val +--- []=(nth, val) nth 番目のバイトを文字列 val で置き換えます。 val が 0 から 255 の範囲の整数である場合、 @@ -622,7 +622,7 @@ val buf[1] = "!!" p buf # => "s!!ring" ---- []=(nth, len, val) -> val +--- []=(nth, len, val) nth バイト番目から長さ len バイトの部分文字列を文字列 val で置き換えます。 nth が負の場合は文字列の末尾から数えます。 @@ -639,7 +639,7 @@ val buf[1, 4] = "!!" p buf # => "s!!g" ---- []=(substr, val) -> val +--- []=(substr, val) 文字列中の substr に一致する最初の部分文字列を文字列 val で置き換えます。 @@ -662,7 +662,7 @@ val buf["nosuchstring"] = "!!" # IndexError #@since 1.8.0 ---- []=(regexp, nth = 0, val) -> () +--- []=(regexp, nth = 0, val) 正規表現 regexp の nth 番目の括弧にマッチする 最初の部分文字列を文字列 val で置き換えます。 @@ -671,7 +671,7 @@ nth 正規表現がマッチしなければ例外 [[c:IndexError]] が発生します。 #@else ---- []=(regexp, val) -> () +--- []=(regexp, val) 正規表現 regexp にマッチする最初の部分文字列を文字列 val で置き換えます。 @@ -698,7 +698,7 @@ val p buf # => "def preprocess(cmd)" #@end ---- []=(range, val) -> val +--- []=(range, val) rangeで指定したインデックスの範囲に含まれる部分文字列を文字列 val で置き換えます。 diff --git a/refm/api/src/_builtin/Struct b/refm/api/src/_builtin/Struct index 26c3ee2..a8419e4 100644 --- a/refm/api/src/_builtin/Struct +++ b/refm/api/src/_builtin/Struct @@ -106,7 +106,7 @@ args[0] p obj[-1] # => "BAR" # Array のように負のインデックスも指定できます。 p obj[2] # => in `[]': offset 2 too large for struct(size:2) (IndexError) ---- []=(member, value) -> object +--- []=(member, value) (このメソッドは Struct の下位クラスにのみ定義されています) 構造体の member で指定されたメンバの値を value にして value を返します。 diff --git a/refm/api/src/csv/CSV__Cell b/refm/api/src/csv/CSV__Cell index 877521c..8c925fd 100644 --- a/refm/api/src/csv/CSV__Cell +++ b/refm/api/src/csv/CSV__Cell @@ -39,7 +39,7 @@ CSV::Cell #@if (version <= '1.8.1') ---- data=(new_data) -> nil +--- data=(new_data) 自分自身のCellデータを書き換えます。 @param new_data 書き換えるデータ @@ -55,7 +55,7 @@ CSV::Cell このメソッドはバージョン1.8.2で廃止されました。 ---- is_null=(new_data) -> nil +--- is_null=(new_data) 自分自身のis_nullフラグを書き換えます。 @param new_data 書き換えるデータ diff --git a/refm/api/src/curses.rd b/refm/api/src/curses.rd index eef2ad2..63c4be0 100644 --- a/refm/api/src/curses.rd +++ b/refm/api/src/curses.rd @@ -1198,7 +1198,7 @@ ESC サポートしていない環境では、例外 NotImplementedError が発生します。 ---- ESCDELAY=(val) -> Integer +--- ESCDELAY=(val) ESC の入力を破棄する時間(ミリ秒単位)を val に設定します。 設定した値を返します。 @@ -1213,7 +1213,7 @@ ESC サポートしていない環境では、例外 NotImplementedError が発生します。 ---- TABSIZE=(val) -> Integer +--- TABSIZE=(val) タブ幅を val に設定します。設定した値を返します。 diff --git a/refm/api/src/gdbm.rd b/refm/api/src/gdbm.rd index dcac6ca..9437a18 100644 --- a/refm/api/src/gdbm.rd +++ b/refm/api/src/gdbm.rd @@ -127,7 +127,7 @@ key データベースが空の時、真を返します。 ---- fastmode=(bool) -> bool +--- fastmode=(bool) オープンしている GDBM オブジェクトのモードを変更します。 @@ -142,7 +142,7 @@ key @see [[m:GDBM::FAST]], [[m:GDBM#syncmode=]] ---- syncmode=(bool) -> bool +--- syncmode=(bool) オープンしている GDBM オブジェクトのモードを変更します。 diff --git a/refm/api/src/io/nonblock.rd b/refm/api/src/io/nonblock.rd index 7924171..3c800fc 100644 --- a/refm/api/src/io/nonblock.rd +++ b/refm/api/src/io/nonblock.rd @@ -8,7 +8,7 @@ IO self がノンブロックモードならばtrueを、 ブロックモードならfalseを返します。 ---- nonblock=(bool) -> Integer +--- nonblock=(bool) bool が真なら self をノンブロックモードに、偽ならブロックモー ドにします。 diff --git a/refm/api/src/net/http.rd b/refm/api/src/net/http.rd index 4e464b7..acb5fde 100644 --- a/refm/api/src/net/http.rd +++ b/refm/api/src/net/http.rd @@ -1198,7 +1198,7 @@ Content-Type Content-Type: ヘッダフィールドが存在しない場合には 空のハッシュを返します。 ---- form_data=(params) -> () +--- form_data=(params) --- set_form_data(params, sep = '&') -> () HTMLのフォームのデータ params から ヘッダフィールドとボディを設定します。 diff --git a/refm/api/src/readline.rd b/refm/api/src/readline.rd index a8447c8..6f7135d 100644 --- a/refm/api/src/readline.rd +++ b/refm/api/src/readline.rd @@ -151,14 +151,14 @@ prompt == Singleton Methods #@since 1.9.1 ---- input=(input) -> File +--- input=(input) readline メソッドで使用する入力用の [[c:File]] オブジェクト input を指定します。 戻り値は指定した [[c:File]] オブジェクト input です。 @param input [[c:File]] オブジェクトを指定します。 ---- output=(output) -> File +--- output=(output) readline メソッドで使用する出力用の [[c:File]] オブジェクト output を指定します。 戻り値は指定した [[c:File]] オブジェクト output です。 @@ -517,7 +517,7 @@ index Readline::HISTORY[2 ** 64 + 1] #=> 例外 RangeError が発生します。 ---- []=(index, string) -> String +--- []=(index, string) ヒストリの index で指定したインデックスの内容を string で指定した文字列で書き換えます。 例えば index に 0 を指定すると最初の入力内容が書き換えます。 diff --git a/refm/api/src/socket/BasicSocket b/refm/api/src/socket/BasicSocket index 21125fb..e98490f 100644 --- a/refm/api/src/socket/BasicSocket +++ b/refm/api/src/socket/BasicSocket @@ -8,7 +8,7 @@ == Class Methods --- do_not_reverse_lookup -> bool ---- do_not_reverse_lookup=(bool) -> bool +--- do_not_reverse_lookup=(bool) この値が真ならアドレスからホスト名への逆引きを行わなくなります。 デフォルトは false です。この設定は大域的に作用します。 diff --git a/refm/api/src/strscan.rd b/refm/api/src/strscan.rd index 1f3a155..7528ecf 100644 --- a/refm/api/src/strscan.rd +++ b/refm/api/src/strscan.rd @@ -542,8 +542,8 @@ StringScanner s.scan(/\s+/) # => " " s.pos # => 5 ---- pointer=(n) -> Fixnum ---- pos=(n) -> Fixnum +--- pointer=(n) +--- pos=(n) スキャンポインタのインデックスを n にセットします。 @param n 整数で、バイト単位で指定します。 @@ -849,7 +849,7 @@ regexp s.scan(/\w+/) # => "0123" (将来は "test" が返る可能性あり) str # => "0123" (将来は "test string" が返る可能性あり) ---- string=(str) -> String +--- string=(str) スキャン対象の文字列を str に変更して、マッチ記録を捨てます。 @param str スキャン対象の文字列を str に変更して、マッチ記録を捨てます。 diff --git a/refm/api/src/webrick/cookie.rd b/refm/api/src/webrick/cookie.rd index 8fe11c7..6d07343 100644 --- a/refm/api/src/webrick/cookie.rd +++ b/refm/api/src/webrick/cookie.rd @@ -100,7 +100,7 @@ Cookie @param value パス名を文字列で指定します。 --- secure -> bool ---- secure=(value) -> bool +--- secure=(value) クッキーのSecure属性を真偽値で表すアクセサです。 diff --git a/refm/api/src/yaml/store.rd b/refm/api/src/yaml/store.rd index 53bd3e3..f794ce9 100644 --- a/refm/api/src/yaml/store.rd +++ b/refm/api/src/yaml/store.rd @@ -76,7 +76,7 @@ YAML p db.fetch("fuga", "ugougo") #=> "ugougo" } ---- []=(name, value) -> object +--- []=(name, value) ルート name に対応する値 value を代入します。 @param name 探索するルートの名前を指定します。 diff --git a/refm/api/src/zlib/GzipReader b/refm/api/src/zlib/GzipReader index edbf166..b0aa056 100644 --- a/refm/api/src/zlib/GzipReader +++ b/refm/api/src/zlib/GzipReader @@ -403,7 +403,7 @@ gzip @see [[m:IO#lineno]] ---- lineno=(num) -> Integer +--- lineno=(num) IO クラスの同名メソッド[[m:IO#lineno=]]と同じです。 但し、gzip ファイル中に diff --git a/refm/api/src/zlib/GzipWriter b/refm/api/src/zlib/GzipWriter index 85baec3..f000521 100644 --- a/refm/api/src/zlib/GzipWriter +++ b/refm/api/src/zlib/GzipWriter @@ -353,7 +353,7 @@ flush #=> "\037\213\b\000p\257pH\002\003J+MO\344\002\000\000\000\377\377*M\317\347\002\000\000\000\377\377\003\000<\326\000\371\t\000\000\000" ---- mtime=(time) -> Fixnum +--- mtime=(time) gzip ファイルのヘッダーに記録する最終更新時間を指定します。 @@ -378,7 +378,7 @@ gzip #=> Thu Jan 01 09:00:01 +0900 1970 } ---- orig_name=(filename) -> String +--- orig_name=(filename) gzip ファイルのヘッダーに記録する元ファイル名を指定します。 @@ -402,7 +402,7 @@ gzip puts gz.orig_name #=> hogehoge } ---- comment=(string) -> String +--- comment=(string) gzip ファイルのヘッダーに記録するコメントを指定します。 diff --git a/refm/api/src/zlib/ZStream b/refm/api/src/zlib/ZStream index 2c05625..1cba9be 100644 --- a/refm/api/src/zlib/ZStream +++ b/refm/api/src/zlib/ZStream @@ -58,7 +58,7 @@ String 出力バッファの空き用量をバイト数で返します。 空きは必要な時に動的に確保されるため、通常は 0 です。 ---- avail_out=(size) -> Integer +--- avail_out=(size) 出力側のバッファに size バイトの空きを確保します。 すでに size バイト以上の空きがある場合、バッファは % ---------------------------------------- http://redmine.ruby-lang.org -- ML: ruby-reference-manual@m... 使い方: http://QuickML.com/
-> 2047 2010-03-25 12:38 [redmine@r... ] [Bug #3013] 「返り値の型の記述方法」の「代入式の場合には省略する。」 2048 2010-03-25 12:43 ┗[okkez000@g... ] 2051 2010-03-26 11:47 ┗[redmine@r... ] [Bug #3013](Closed) 「返り値の型の記述方法」の「代入式の場合には省略する。」