summaryrefslogtreecommitdiff
path: root/doc/ref/api-debug.texi
diff options
context:
space:
mode:
authorNeil Jerram <neil@ossau.uklinux.net>2009-08-04 15:40:06 +0100
committerNeil Jerram <neil@ossau.uklinux.net>2009-08-21 23:25:25 +0100
commit916f175fb40cd20ee48f808b21d7a6a32d12dd17 (patch)
tree742354866bb116661238d1f71a1f339e348b016b /doc/ref/api-debug.texi
parent5f5f251895818a8dec3acfc3832012088d07a7ee (diff)
downloadguile-916f175fb40cd20ee48f808b21d7a6a32d12dd17.tar.gz
Minor improvements to doc on source properties
In particular avoid any suggestion that the API uses the property list format, i.e. (key1 value1 key2 value2 ...), as opposed to the alist format that it actually does use.
Diffstat (limited to 'doc/ref/api-debug.texi')
-rw-r--r--doc/ref/api-debug.texi18
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/ref/api-debug.texi b/doc/ref/api-debug.texi
index 28dc73233..42e0676a6 100644
--- a/doc/ref/api-debug.texi
+++ b/doc/ref/api-debug.texi
@@ -283,9 +283,9 @@ runs a script non-interactively.
The following procedures can be used to access and set the source
properties of read expressions.
-@deffn {Scheme Procedure} set-source-properties! obj plist
-@deffnx {C Function} scm_set_source_properties_x (obj, plist)
-Install the association list @var{plist} as the source property
+@deffn {Scheme Procedure} set-source-properties! obj alist
+@deffnx {C Function} scm_set_source_properties_x (obj, alist)
+Install the association list @var{alist} as the source property
list for @var{obj}.
@end deffn
@@ -302,12 +302,12 @@ Return the source property association list of @var{obj}.
@deffn {Scheme Procedure} source-property obj key
@deffnx {C Function} scm_source_property (obj, key)
-Return the source property specified by @var{key} from
-@var{obj}'s source property list.
+Return the property specified by @var{key} from @var{obj}'s source
+properties.
@end deffn
In practice there are only two ways that you should use the ability to
-set an expression's source breakpoints.
+set an expression's source properties.
@itemize
@item
@@ -330,9 +330,9 @@ involved in a backtrace or error report.
If you are looking for a way to attach arbitrary information to an
expression other than these properties, you should use
-@code{make-object-property} instead (@pxref{Object Properties}), because
-that will avoid bloating the source property hash table, which is really
-only intended for the specific purposes described in this section.
+@code{make-object-property} instead (@pxref{Object Properties}). That
+will avoid bloating the source property hash table, which is really
+only intended for the debugging purposes just described.
@node Decoding Memoized Source Expressions