From c02ffd9a8ff79324ae178adf41f5d18f3b4ca634 Mon Sep 17 00:00:00 2001
From: hsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Wed, 29 Jul 2015 01:44:49 +0000
Subject: * gc.c: document argument passed to finalizer proc.   [fix GH-976][ci
 skip] Patch by @alexdowad

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@51418 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 gc.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'gc.c')

diff --git a/gc.c b/gc.c
index 3cb5a61324..ac4f575241 100644
--- a/gc.c
+++ b/gc.c
@@ -2474,7 +2474,9 @@ should_be_finalizable(VALUE obj)
  *     ObjectSpace.define_finalizer(obj, aProc=proc())
  *
  *  Adds <i>aProc</i> as a finalizer, to be called after <i>obj</i>
- *  was destroyed.
+ *  was destroyed. The object ID of the <i>obj</i> will be passed
+ *  as an argument to <i>aProc</i>. If <i>aProc</i> is a lambda or
+ *  method, make sure it can be called with a single argument.
  *
  */
 
-- 
cgit v1.2.3