* gc.c (WeakMap): Add doc for internal reference, use lib/weakref.rb

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

1 files changed, 4 insertions, 1 deletions

diff --git a/gc.c b/gc.c
index 9e2da52ffc..dfbc82b7b9 100644
--- a/gc.c
+++ b/gc.c
@@ -4412,7 +4412,10 @@ rb_gcdebug_sentinel(VALUE obj, const char *name)
  *  Document-class: ObjectSpace::WeakMap
  *
  *  An ObjectSpace::WeakMap object holds references to
- *  any objects, but those objects can get disposed by GC.
+ *  any objects, but those objects can get be garbage collected.
+ *
+ *  This class is mostly used internally by WeakRef, please use
+ *  +lib/weakref.rb+ for the public interface.
  */
 
 /*  Document-class: GC::Profiler