Current File : /var/lib/rbenv/versions/3.2.2/lib64/ruby/gems/3.2.0/gems/rbs-2.8.2/core/warning.rbs
# <!-- rdoc-file=error.c -->
# The Warning module contains a single method named #warn, and the module
# extends itself, making Warning.warn available. Warning.warn is called for all
# warnings issued by Ruby. By default, warnings are printed to $stderr.
#
# Changing the behavior of Warning.warn is useful to customize how warnings are
# handled by Ruby, for instance by filtering some warnings, and/or outputting
# warnings somewhere other than $stderr.
#
# If you want to change the behavior of Warning.warn you should use
# +Warning.extend(MyNewModuleWithWarnMethod)+ and you can use `super` to get the
# default behavior of printing the warning to $stderr.
#
# Example:
# module MyWarningFilter
# def warn(message, category: nil, **kwargs)
# if /some warning I want to ignore/.match?(message)
# # ignore
# else
# super
# end
# end
# end
# Warning.extend MyWarningFilter
#
# You should never redefine Warning#warn (the instance method), as that will
# then no longer provide a way to use the default behavior.
#
# The `warning` gem provides convenient ways to customize Warning.warn.
#
module Warning
# <!--
# rdoc-file=error.c
# - warn(msg, category: nil) -> nil
# -->
# Writes warning message `msg` to $stderr. This method is called by Ruby for all
# emitted warnings. A `category` may be included with the warning.
#
# See the documentation of the Warning module for how to customize this.
#
def self?.warn: (String message, ?category: :deprecated | :experimental | nil) -> nil
end
Mini Shell