summaryrefslogtreecommitdiff
path: root/warning.rb
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2020-12-08 19:32:33 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2020-12-08 22:13:04 +0900
commitd5ffa4e9a43ebdd451fb2c46529d301dec03f666 (patch)
tree8e77bd3385bfea1fa09c1c6154be754005f03e4f /warning.rb
parent2427393b4d1ea0557362b106044e3aba3da32370 (diff)
[DOC] mentioned category option
Diffstat (limited to 'warning.rb')
-rw-r--r--warning.rb5
1 files changed, 4 insertions, 1 deletions
diff --git a/warning.rb b/warning.rb
index 22acd3424e..764e352296 100644
--- a/warning.rb
+++ b/warning.rb
@@ -5,7 +5,7 @@ module Kernel
module_function
# call-seq:
- # warn(*msgs, uplevel: nil) -> nil
+ # warn(*msgs, uplevel: nil, category: nil) -> nil
#
# If warnings have been disabled (for example with the
# <code>-W0</code> flag), does nothing. Otherwise,
@@ -39,6 +39,9 @@ module Kernel
#
# baz.rb:6: warning: invalid call to foo
#
+ # If the +category+ keyword argument is given, it is passed to
+ # Warning.warn method.
+ #
def warn(*msgs, uplevel: nil, category: nil)
Primitive.rb_warn_m(msgs, uplevel, category)
end