summaryrefslogtreecommitdiff
path: root/warning.rb
diff options
context:
space:
mode:
Diffstat (limited to 'warning.rb')
-rw-r--r--warning.rb11
1 files changed, 8 insertions, 3 deletions
diff --git a/warning.rb b/warning.rb
index 764e352296..0012ffb1d6 100644
--- a/warning.rb
+++ b/warning.rb
@@ -39,9 +39,14 @@ module Kernel
#
# baz.rb:6: warning: invalid call to foo
#
- # If the +category+ keyword argument is given, it is passed to
- # Warning.warn method.
- #
+ # If <code>category</code> keyword argument is given, passes the category
+ # to <code>Warning.warn</code>. The category given must be be one of the
+ # following categories:
+ #
+ # :deprecated :: Used for warning for deprecated functionality that may
+ # be removed in the future.
+ # :experimental :: Used for experimental features that may change in
+ # future releases.
def warn(*msgs, uplevel: nil, category: nil)
Primitive.rb_warn_m(msgs, uplevel, category)
end