diff options
author | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-12-24 08:11:49 +0000 |
---|---|---|
committer | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-12-24 08:11:49 +0000 |
commit | e69dbc09618cb3f445e6d936800cea097e6133b7 (patch) | |
tree | aee8e5ac798f707bbc4a198f5d8bc00dcfbf018c | |
parent | 72c62dc0865ef572f8502bcb1c8b6309869a162e (diff) |
Document the "cause" keyword argument for raise
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66525 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r-- | eval.c | 13 |
1 files changed, 9 insertions, 4 deletions
@@ -706,11 +706,11 @@ extract_raise_opts(int argc, const VALUE *argv, VALUE *opts) /* * call-seq: * raise - * raise(string) - * raise(exception [, string [, array]]) + * raise(string, cause: $!) + * raise(exception [, string [, array]], cause: $!) * fail - * fail(string) - * fail(exception [, string [, array]]) + * fail(string, cause: $!) + * fail(exception [, string [, array]], cause: $!) * * With no arguments, raises the exception in <code>$!</code> or raises * a <code>RuntimeError</code> if <code>$!</code> is +nil+. @@ -725,6 +725,11 @@ extract_raise_opts(int argc, const VALUE *argv, VALUE *opts) * * raise "Failed to create socket" * raise ArgumentError, "No parameters", caller + * + * The +cause+ of the generated exception is automatically set to the + * "current" exception (<code>$!</code>) if any. An alternative + * value, either an +Exception+ object or +nil+, can be specified via + * the +:cause+ argument. */ static VALUE |