summaryrefslogtreecommitdiff
path: root/object.c
diff options
context:
space:
mode:
authorknu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2007-03-03 07:09:24 +0000
committerknu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2007-03-03 07:09:24 +0000
commitff18a5d9ed434bb0c9c68f492e2462a70b1fced6 (patch)
tree45bd04ce75f87ea549aacb8f433c35641bc34db2 /object.c
parent4cbc07a8268a8b22268994518cd66b44c2498000 (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_6@11963 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'object.c')
-rw-r--r--object.c10
1 files changed, 6 insertions, 4 deletions
diff --git a/object.c b/object.c
index 3719817..7064557 100644
--- a/object.c
+++ b/object.c
@@ -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)