summaryrefslogtreecommitdiff
path: root/object.c
diff options
context:
space:
mode:
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)