diff options
| -rw-r--r-- | doc/extension.ja.rdoc | 8 | ||||
| -rw-r--r-- | doc/extension.rdoc | 7 |
2 files changed, 7 insertions, 8 deletions
diff --git a/doc/extension.ja.rdoc b/doc/extension.ja.rdoc index 2117fe20aa..2c46cfcae6 100644 --- a/doc/extension.ja.rdoc +++ b/doc/extension.ja.rdoc @@ -1409,10 +1409,10 @@ int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optiona optional (optionalが負の場合は-optional-1) 個のIDは省略可能 キーワードです．必須キーワードがkeyword_hash中にない場合， "missing keyword"ArgumentErrorが発生します．省略可能キーワー - ドがない場合は，values中の対応する要素は変更されません． - keyword_hashに使用されない要素がある場合は，optionalが負なら - 新しいHashとして省略可能引数の次に保存されますが，そうでなけ - れば"unknown keyword"ArgumentErrorが発生します． + ドがない場合は，values中の対応する要素にはQundefがセットされ + ます．keyword_hashに使用されない要素がある場合は，optionalが + 負なら無視されますが，そうでなければ"unknown keyword" + ArgumentErrorが発生します． VALUE rb_extract_keywords(VALUE *original_hash) :: diff --git a/doc/extension.rdoc b/doc/extension.rdoc index 42a445602b..ba6319afc6 100644 --- a/doc/extension.rdoc +++ b/doc/extension.rdoc @@ -1431,10 +1431,9 @@ int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optiona +optional+ is negative) number of IDs are optional. If a mandatory key is not contained in +keyword_hash+, raises "missing keyword" +ArgumentError+. If an optional key is not present in - +keyword_hash+, the corresponding element in +values+ is not changed. - If +optional+ is negative, rest of +keyword_hash+ are stored in the - next to optional +values+ as a new Hash, otherwise raises "unknown - keyword" +ArgumentError+. + +keyword_hash+, the corresponding element in +values+ is set to +Qundef+. + If +optional+ is negative, rest of +keyword_hash+ are ignored, otherwise + raises "unknown keyword" +ArgumentError+. Be warned, handling keyword arguments in the C API is less efficient than handling them in Ruby. Consider using a Ruby wrapper method |