summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Ryde <user42@zip.com.au>2003-07-28 23:27:03 +0000
committerKevin Ryde <user42@zip.com.au>2003-07-28 23:27:03 +0000
commit3212db7eda84d4a6aeec733ba19dfd16bef48e4e (patch)
tree1efca4626099b0603aecc418f6953c4d8332683d
parentc6ccee3417e289ae4be5ceca0d704dd28f06c7f9 (diff)
downloadguile-3212db7eda84d4a6aeec733ba19dfd16bef48e4e.tar.gz
(Property Primitives): In primitive-property-ref,
note parameters to not-found-proc, use hyphens rather than underscores for that parameter name. In primitive-property-set!, VAL is the value parameter not CODE.
-rw-r--r--doc/ref/scheme-utility.texi20
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/ref/scheme-utility.texi b/doc/ref/scheme-utility.texi
index e563ecc12..d323eef4a 100644
--- a/doc/ref/scheme-utility.texi
+++ b/doc/ref/scheme-utility.texi
@@ -147,28 +147,28 @@ protected by the table.
@node Property Primitives
@subsection Low Level Property Implementation.
-@deffn {Scheme Procedure} primitive-make-property not_found_proc
+@deffn {Scheme Procedure} primitive-make-property not-found-proc
@deffnx {C Function} scm_primitive_make_property (not_found_proc)
Create a @dfn{property token} that can be used with
@code{primitive-property-ref} and @code{primitive-property-set!}.
See @code{primitive-property-ref} for the significance of
-@var{not_found_proc}.
+@var{not-found-proc}.
@end deffn
@deffn {Scheme Procedure} primitive-property-ref prop obj
@deffnx {C Function} scm_primitive_property_ref (prop, obj)
-Return the property @var{prop} of @var{obj}. When no value
-has yet been associated with @var{prop} and @var{obj}, call
-@var{not-found-proc} instead (see @code{primitive-make-property})
-and use its return value. That value is also associated with
-@var{obj} via @code{primitive-property-set!}. When
-@var{not-found-proc} is @code{#f}, use @code{#f} as the
-default value of @var{prop}.
+Return the property @var{prop} of @var{obj}.
+
+When no value has yet been associated with @var{prop} and @var{obj},
+the @var{not-found-proc} from @var{prop} is used. A call
+@code{(@var{not-found-proc} @var{prop} @var{obj})} is made and the
+result set as the property value. If @var{not-found-proc} is
+@code{#f} then @code{#f} is the property value.
@end deffn
@deffn {Scheme Procedure} primitive-property-set! prop obj val
@deffnx {C Function} scm_primitive_property_set_x (prop, obj, val)
-Associate @var{code} with @var{prop} and @var{obj}.
+Set the property @var{prop} of @var{obj} to @var{val}.
@end deffn
@deffn {Scheme Procedure} primitive-property-del! prop obj