From 5c461d1eee028a3e833adb85263d608a0809b429 Mon Sep 17 00:00:00 2001 From: normal Date: Thu, 4 Jun 2015 21:45:23 +0000 Subject: 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 --- doc/extension.rdoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc/extension.rdoc') 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 -- cgit v1.2.3