aboutsummaryrefslogtreecommitdiffstats
path: root/doc/extension.rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/extension.rdoc')
-rw-r--r--doc/extension.rdoc3
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