* 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

1 files changed, 6 insertions, 4 deletions

diff --git a/object.c b/object.c
index 3719817d8c..706455713c 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)