summaryrefslogtreecommitdiff
path: root/object.c
diff options
context:
space:
mode:
authormatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2007-03-01 22:59:12 +0000
committermatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2007-03-01 22:59:12 +0000
commit582f1ecdfbad7147e7c0668fc072441503cb7ba1 (patch)
tree76b1c8968716f1f707f42adb0e4ac0caf2e20479 /object.c
parentcd725929d7241166733f2028cc71640b055ce267 (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/trunk@11955 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 d1c53717e3..a27e17efa7 100644
--- a/object.c
+++ b/object.c
@@ -1659,10 +1659,12 @@ rb_obj_public_methods(int argc, VALUE *argv, VALUE 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 @ part of the variable name
+ * should be included for regular instance variables. Throws a
+ * NameError exception if the supplied symbol is not valid as an
+ * instance variable name.
*
* class Fred
* def initialize(p1, p2)