kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Document the Warning module and warn method

Browse source 
* error.c (Warning): add documentation. [Feature #13504]
  Author: Jeremy Evans <code@jeremyevans.net>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58472 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
eregon 2017-04-25 09:10:46 +00:00
parent 5ad56e7c0b
commit 905d52772c
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
error.c
View file

@ -136,6 +136,15 @@ ruby_deprecated_internal_feature(const char *func)
rb_fatal("%s is only for internal use and deprecated; do not use", func);
}
/*
* call-seq:
* warn(msg) -> nil
*
* Writes warning message to $stderr, followed by a newline
* if the message does not end in a newline. This method is called
* by ruby for all emitted warnings.
*/
static VALUE
rb_warning_s_warn(VALUE mod, VALUE str)
{
@ -145,6 +154,22 @@ rb_warning_s_warn(VALUE mod, VALUE str)
return Qnil;
}
/*
* Document-module: Warning
*
* 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.
*
* By overriding Warning.warn, you can change how warnings are
* handled by ruby, either filtering some warnings, and/or outputing
* warnings somewhere other than $stderr. When Warning.warn is
* overridden, super can be called to get the default behavior of
* printing the warning to $stderr.
*
*/
VALUE
rb_warning_warn(VALUE mod, VALUE str)
{