suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve docs for FFI custodian API. (#1684)

Browse Source 
Improve docs for FFI custodian API.

The docs were unclear on when an object goes from weakly to strongly
held.

Also add a missing space
This commit is contained in:
Leif Andersen 2017-05-12 16:32:25 -04:00 committed by GitHub
parent f43234e1cb
commit cd1e56bfaf
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
pkgs/racket-doc/scribblings/inside/custodians.scrbl
View File

@ -51,16 +51,18 @@ be remembered until either the custodian shuts it down or
zero, the value is allowed to be garbage collected (and automatically
removed from the custodian).
Independent of whether @var{strong} is zero, the value @var{o} is
initially weakly held. A value associated with a custodian can
therefore be finalized via will executors.
Independent of whether @var{strong} is zero, the value @var{o}
is initially weakly held and becomes strongly held when
the garbage collector attempts to collect it. A value
associated with a custodian can therefore be finalized via
will executors.
The return value from @cpp{scheme_add_managed} can be used to refer
to the value's custodian later in a call to
@cpp{scheme_remove_managed}. A value can be registered with at
most one custodian.
If @var{m} (or the current custodian if @var{m} is @cpp{NULL})is shut
If @var{m} (or the current custodian if @var{m} is @cpp{NULL}) is shut
down, then @var{f} is called immediately, and the result is
@cpp{NULL}.}