summaryrefslogtreecommitdiff
path: root/error.c
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-12-29 23:40:15 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-12-29 23:40:15 +0000
commit2eee74ef54a2e23eb870680a83dcf74c5d9d9d01 (patch)
tree5a7eb996262cac617a3e39b61766ca2943e59a18 /error.c
parent65b1cf0e82255db68262dfb8fdb001268981e223 (diff)
Update NoMethodError/NameError docs [ci skip]
[ruby-core:90796] [Bug #15481] From: zverok (Victor Shepelev) <zverok.offline@gmail.com> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66644 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'error.c')
-rw-r--r--error.c17
1 files changed, 13 insertions, 4 deletions
diff --git a/error.c b/error.c
index a085afd800..beae3b8138 100644
--- a/error.c
+++ b/error.c
@@ -1451,12 +1451,15 @@ name_err_init_attr(VALUE exc, VALUE recv, VALUE method)
/*
* call-seq:
- * NameError.new(msg [, name]) -> name_error
- * NameError.new(msg [, name], receiver:) -> name_error
+ * NameError.new(msg=nil, name=nil, receiver: nil) -> name_error
*
* Construct a new NameError exception. If given the <i>name</i>
* parameter may subsequently be examined using the <code>NameError#name</code>
- * method.
+ * method. <i>receiver</i> parameter allows to pass object in
+ * context of which the error happened. Example:
+ *
+ * [1, 2, 3].method(:rject) # NameError with name "rject" and receiver: Array
+ * [1, 2, 3].singleton_method(:rject) # NameError with name "rject" and receiver: [1, 2, 3]
*/
static VALUE
@@ -1535,12 +1538,18 @@ nometh_err_init_attr(VALUE exc, VALUE args, int priv)
/*
* call-seq:
- * NoMethodError.new([msg, *, name [, args [, priv]]]) -> no_method_error
+ * NoMethodError.new(msg=nil, name=nil, args=nil, private=false, receiver: nil) -> no_method_error
*
* Construct a NoMethodError exception for a method of the given name
* called with the given arguments. The name may be accessed using
* the <code>#name</code> method on the resulting object, and the
* arguments using the <code>#args</code> method.
+ *
+ * If <i>private</i> argument were passed, it designates method was
+ * attempted to call in private context, and can be accessed with
+ * <code>#private_call?</code> method.
+ *
+ * <i>receiver</i> argument stores an object whose method was called.
*/
static VALUE