diff options
author | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-03-03 07:07:44 +0000 |
---|---|---|
committer | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-03-03 07:07:44 +0000 |
commit | 618510d30c27fd490cb7a0faa55837d1a46d08b4 (patch) | |
tree | 8bc44b8eaf3c137c8452474315688a5525c4ef89 /object.c | |
parent | ed3fdff77ef6c3904acdb276ab5a997c6c331d3a (diff) |
* object.c (rb_obj_ivar_set): RDoc updated according to a
suggestion from Brian Candler <B.Candler AT pobox.com>.
[ruby-core:10469]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@11962 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'object.c')
-rw-r--r-- | object.c | 10 |
1 files changed, 6 insertions, 4 deletions
@@ -1966,10 +1966,12 @@ rb_obj_public_methods(argc, argv, obj) /* * call-seq: * obj.instance_variable_get(symbol) => obj - * - * Returns the value of the given instance variable (or throws a - * <code>NameError</code> exception). The <code>@</code> part of the - * variable name should be included for regular instance variables + * + * Returns the value of the given instance variable, or nil if the + * instance variable is not set. The <code>@</code> part of the + * variable name should be included for regular instance + * variables. Throws a <code>NameError</code> exception if the + * supplied symbol is not valid as an instance variable name. * * class Fred * def initialize(p1, p2) |