path: root/doc
diff options
authornormal <normal@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2015-06-04 21:45:23 +0000
committernormal <normal@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2015-06-04 21:45:23 +0000
commit5c461d1eee028a3e833adb85263d608a0809b429 (patch)
treed7120cd315b00cc72485ad81625c650aeaa4f0fa /doc
parent4dd6c370b99e15bb6dd5b97522ad1a3851b71d73 (diff)
doc/extension.rdoc: note rb_get_kwargs changes keywords_hash [ci skip]
[ruby-core:68507] git-svn-id: svn+ssh:// b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'doc')
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/extension.rdoc b/doc/extension.rdoc
index 0cb1d00..00e789f 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