From cd1e56bfaf23f2c04078f7566d287cd16e65e7c2 Mon Sep 17 00:00:00 2001 From: Leif Andersen Date: Fri, 12 May 2017 16:32:25 -0400 Subject: [PATCH] Improve docs for FFI custodian API. (#1684) 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 --- pkgs/racket-doc/scribblings/inside/custodians.scrbl | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/pkgs/racket-doc/scribblings/inside/custodians.scrbl b/pkgs/racket-doc/scribblings/inside/custodians.scrbl index ade86fce00..d88637bac3 100644 --- a/pkgs/racket-doc/scribblings/inside/custodians.scrbl +++ b/pkgs/racket-doc/scribblings/inside/custodians.scrbl @@ -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}.}