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

* object.c: [DOC] Document first argument also takes string for:

Browse source 
rb_mod_const_get, rb_mod_const_set, rb_mod_const_defined

  Also added note about NameError exception for invalid constant name


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@43412 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
zzak 2013-10-24 03:48:54 +00:00
parent 61430a167b
commit ec9ec26430
2 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
ChangeLog
View file

@ -1,3 +1,11 @@
Thu Oct 24 12:45:53 2013 Zachary Scott <e@zzak.io>
* object.c: [DOC] Document first argument also takes string for:
rb_mod_const_get, rb_mod_const_set, rb_mod_const_defined
Also added note about NameError exception for invalid constant name
Thu Oct 24 12:23:58 2013 KOSAKI Motohiro <kosaki.motohiro@gmail.com> Thu Oct 24 12:23:58 2013 KOSAKI Motohiro <kosaki.motohiro@gmail.com>
* thread.c (rb_thread_terminate_all): add a comment why we need * thread.c (rb_thread_terminate_all): add a comment why we need

20
object.c
View file

@ -2034,6 +2034,12 @@ rb_mod_attr_accessor(int argc, VALUE *argv, VALUE klass)
* *
* Object.const_get 'Foo::Baz::VAL' # => 10 * Object.const_get 'Foo::Baz::VAL' # => 10
* Object.const_get 'Foo::Baz::VAL', false # => NameError * Object.const_get 'Foo::Baz::VAL', false # => NameError
*
* If neither +sym+ nor +str+ is not a valid constant name a NameError will be
* raised with a warning "wrong constant name".
*
* Object.const_get 'foobar' #=> NameError: wrong constant name foobar
*
*/ */
static VALUE static VALUE
@ -2136,6 +2142,7 @@ rb_mod_const_get(int argc, VALUE *argv, VALUE mod)
/* /*
* call-seq: * call-seq:
* mod.const_set(sym, obj) -> obj * mod.const_set(sym, obj) -> obj
* mod.const_set(str, obj) -> obj
* *
* Sets the named constant to the given object, returning that object. * Sets the named constant to the given object, returning that object.
* Creates a new constant if no constant with the given name previously * Creates a new constant if no constant with the given name previously
@ -2143,6 +2150,12 @@ rb_mod_const_get(int argc, VALUE *argv, VALUE mod)
* *
* Math.const_set("HIGH_SCHOOL_PI", 22.0/7.0) #=> 3.14285714285714 * Math.const_set("HIGH_SCHOOL_PI", 22.0/7.0) #=> 3.14285714285714
* Math::HIGH_SCHOOL_PI - Math::PI #=> 0.00126448926734968 * Math::HIGH_SCHOOL_PI - Math::PI #=> 0.00126448926734968
*
* If neither +sym+ nor +str+ is not a valid constant name a NameError will be
* raised with a warning "wrong constant name".
*
* Object.const_set('foobar', 42) #=> NameError: wrong constant name foobar
*
*/ */
static VALUE static VALUE
@ -2156,6 +2169,7 @@ rb_mod_const_set(VALUE mod, VALUE name, VALUE value)
/* /*
* call-seq: * call-seq:
* mod.const_defined?(sym, inherit=true) -> true or false * mod.const_defined?(sym, inherit=true) -> true or false
* mod.const_defined?(str, inherit=true) -> true or false
* *
* Checks for a constant with the given name in <i>mod</i> * Checks for a constant with the given name in <i>mod</i>
* If +inherit+ is set, the lookup will also search * If +inherit+ is set, the lookup will also search
@ -2166,6 +2180,12 @@ rb_mod_const_set(VALUE mod, VALUE name, VALUE value)
* Math.const_defined? "PI" #=> true * Math.const_defined? "PI" #=> true
* IO.const_defined? :SYNC #=> true * IO.const_defined? :SYNC #=> true
* IO.const_defined? :SYNC, false #=> false * IO.const_defined? :SYNC, false #=> false
*
* If neither +sym+ nor +str+ is not a valid constant name a NameError will be
* raised with a warning "wrong constant name".
*
* Hash.const_defined? 'foobar' #=> NameError: wrong constant name foobar
*
*/ */
static VALUE static VALUE