diff options
author | hsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2015-07-29 01:44:49 +0000 |
---|---|---|
committer | hsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2015-07-29 01:44:49 +0000 |
commit | c02ffd9a8ff79324ae178adf41f5d18f3b4ca634 (patch) | |
tree | 4a31d3310d49b9e88ca78bb8523debd5c0bd9c51 /gc.c | |
parent | 72272159d8e4c63225c7be1d35e4daf8dcc80e6c (diff) |
* 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
Diffstat (limited to 'gc.c')
-rw-r--r-- | gc.c | 4 |
1 files changed, 3 insertions, 1 deletions
@@ -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. * */ |