summaryrefslogtreecommitdiff
path: root/error.c
diff options
context:
space:
mode:
authorkazu <kazu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-01-24 00:03:51 (GMT)
committerkazu <kazu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-01-24 00:03:51 (GMT)
commit49a23c27deb42ac87f056527c9281ee2e32f8f9e (patch)
treea13eeb9551570642bfb15b7c0bbde6d92a4e0127 /error.c
parenta41005eb6a99376ea940888bcf97140643d18f61 (diff)
Add documentation for the Kernel#warn :uplevel keyword
[ruby-core:84574] [Bug #14264] Author: Jeremy Evans <code@jeremyevans.net> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@62018 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'error.c')
-rw-r--r--error.c19
1 files changed, 19 insertions, 0 deletions
diff --git a/error.c b/error.c
index d760de2..2aa5169 100644
--- a/error.c
+++ b/error.c
@@ -323,6 +323,25 @@ warning_write(int argc, VALUE *argv, VALUE buf)
*
* warning 1
* warning 2
+ *
+ * If the <code>:uplevel</code> keyword is given, the string will
+ * be prepended with information for the given caller frame in
+ * the same format used by the <code>rb_warn</code> C function.
+ *
+ * # In baz.rb
+ * def foo
+ * warn("invalid call to foo", uplevel: 1)
+ * end
+ *
+ * def bar
+ * foo
+ * end
+ *
+ * bar
+ *
+ * <em>produces:</em>
+ *
+ * baz.rb:6: warning: invalid call to foo
*/
static VALUE