doco primitive-property-ref

doco primitive-property-ref

[Kevin Ryde]

[-- Attachment #1: Type: text/plain, Size: 888 bytes --]

Following up on something I noticed a while ago,

        * scheme-utility.texi (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.


 - Scheme Procedure: primitive-property-ref prop obj
 - C Function: scm_primitive_property_ref (prop, obj)
     Return the property PROP of OBJ.

     When no value has yet been associated with PROP and OBJ, the
     NOT-FOUND-PROC from PROP is used.  A call `(NOT-FOUND-PROC PROP
     OBJ)' is made and the result set as the property value.  If
     NOT-FOUND-PROC is `#f' then `#f' is the property value.

 - Scheme Procedure: primitive-property-set! prop obj val
 - C Function: scm_primitive_property_set_x (prop, obj, val)
     Set the property PROP of OBJ to VAL.



[-- Attachment #2: scheme-utility.texi.primitive-prop.diff --]
[-- Type: text/plain, Size: 1862 bytes --]

--- scheme-utility.texi.~1.9.~	2003-06-12 08:49:30.000000000 +1000
+++ scheme-utility.texi	2003-07-20 12:01:46.000000000 +1000
@@ -147,28 +147,28 @@
 @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

[-- Attachment #3: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: doco primitive-property-ref

[Kevin Ryde]

I wrote:
>
>         * scheme-utility.texi (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.

I applied a similar change to the docstrings in the code too.


_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel