* eval.c: Improve rdoc for Module.constants [issue #5887]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@34280 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 13 insertions, 5 deletions

diff --git a/eval.c b/eval.c
index ddbe31a477..34ff32c0cf 100644
--- a/eval.c
+++ b/eval.c
@@ -286,15 +286,23 @@ rb_mod_nesting(void)
 /*
  *  call-seq:
  *     Module.constants   -> array
+ *     Module.constants(inherited)   -> array
  *
- *  Returns an array of the names of all constants defined in the
- *  system. This list includes the names of all modules and classes.
+ *  In the first form, returns an array of the names of all
+ *  constants accessible from the point of call.
+ *  This list includes the names of all modules and classes
+ *  defined in the global scope.
  *
- *     p Module.constants.sort[1..5]
+ *     Module.constants.first(4)
+ *        # => [:ARGF, :ARGV, :ArgumentError, :Array]
  *
- *  <em>produces:</em>
+ *     Module.constants.include?(:SEEK_SET)   # => false
+ *
+ *     class IO
+ *       Module.constants.include?(:SEEK_SET) # => true
+ *     end
  *
- *     ["ARGV", "ArgumentError", "Array", "Bignum", "Binding"]
+ *  The second form calls the instance method +constants+.
  */
 
 static VALUE