1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

Document the "cause" keyword argument for raise

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66525 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
knu 2018-12-24 08:11:49 +00:00
parent 72c62dc086
commit e69dbc0961

13
eval.c
View file

@ -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