diff options
| author | normal <normal@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2015-06-04 21:45:23 +0000 |
|---|---|---|
| committer | normal <normal@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2015-06-04 21:45:23 +0000 |
| commit | 26216af20aa50aea748b7fbe3bba69fc7f7a3fae (patch) | |
| tree | d7120cd315b00cc72485ad81625c650aeaa4f0fa /doc | |
| parent | 58ed81c69f0aee330410b1cc6788a9074d9ca385 (diff) | |
| download | ruby-26216af20aa50aea748b7fbe3bba69fc7f7a3fae.tar.gz | |
doc/extension.rdoc: note rb_get_kwargs changes keywords_hash [ci skip]
[ruby-core:68507]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@50778 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/extension.rdoc | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/extension.rdoc b/doc/extension.rdoc index 0cb1d005a3..00e789f585 100644 --- a/doc/extension.rdoc +++ b/doc/extension.rdoc @@ -1401,7 +1401,8 @@ rb_scan_args(int argc, VALUE *argv, const char *fmt, ...) :: int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values) Retrieves argument VALUEs bound to keywords, which directed by +table+ - into +values+. First +required+ number of IDs referred by +table+ are + into +values+, deleting retrieved entries from +keyword_hash+ along + the way. First +required+ number of IDs referred by +table+ are mandatory, and succeeding +optional+ (- +optional+ - 1 if +optional+ is negative) number of IDs are optional. If a mandatory key is not contained in +keyword_hash+, raises "missing |