kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

extension.rdoc: fix rb_get_kwargs [ci skip]

Browse source 
* doc/extension.rdoc: [DOC] optional keyword arguments are
  defaulted to Qundef.  ignored keys are kept in the hash but a
  new Hash is not created.  [ruby-dev:49893] [Bug #13004]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56980 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
nobu 2016-12-04 08:50:28 +00:00
parent b16d1968e6
commit b62e322017
2 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/extension.ja.rdoc
View file

@ -1409,10 +1409,10 @@ int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optiona
optional (optionalが負の場合は-optional-1) 個のIDは省略可能 optional (optionalが負の場合は-optional-1) 個のIDは省略可能
キーワードです．必須キーワードがkeyword_hash中にない場合， キーワードです．必須キーワードがkeyword_hash中にない場合，
"missing keyword"ArgumentErrorが発生します．省略可能キーワー "missing keyword"ArgumentErrorが発生します．省略可能キーワー
ドがない場合は，values中の対応する要素は変更されません． ドがない場合は，values中の対応する要素にはQundefがセットされ
keyword_hashに使用されない要素がある場合は，optionalが負なら ます．keyword_hashに使用されない要素がある場合は，optionalが
新しいHashとして省略可能引数の次に保存されますが，そうでなけ 負なら無視されますが，そうでなければ"unknown keyword"
れば"unknown keyword"ArgumentErrorが発生します． ArgumentErrorが発生します．
VALUE rb_extract_keywords(VALUE *original_hash) :: VALUE rb_extract_keywords(VALUE *original_hash) ::

7
doc/extension.rdoc
View file

@ -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 +optional+ is negative) number of IDs are optional. If a
mandatory key is not contained in +keyword_hash+, raises "missing mandatory key is not contained in +keyword_hash+, raises "missing
keyword" +ArgumentError+. If an optional key is not present in keyword" +ArgumentError+. If an optional key is not present in
+keyword_hash+, the corresponding element in +values+ is not changed. +keyword_hash+, the corresponding element in +values+ is set to +Qundef+.
If +optional+ is negative, rest of +keyword_hash+ are stored in the If +optional+ is negative, rest of +keyword_hash+ are ignored, otherwise
next to optional +values+ as a new Hash, otherwise raises "unknown raises "unknown keyword" +ArgumentError+.
keyword" +ArgumentError+.
Be warned, handling keyword arguments in the C API is less efficient Be warned, handling keyword arguments in the C API is less efficient
than handling them in Ruby. Consider using a Ruby wrapper method than handling them in Ruby. Consider using a Ruby wrapper method