summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMark H Weaver <mhw@netris.org>2014-02-07 16:26:38 -0500
committerMark H Weaver <mhw@netris.org>2014-02-07 16:26:38 -0500
commit54cded99dc5db94b1df0dc417161ebef7c60d874 (patch)
treeec3fd1a741600faa93dde15afbca3c4105289f47 /doc
parent2f3b7e9a41677bfe802e8a1ee851827297384c58 (diff)
downloadguile-54cded99dc5db94b1df0dc417161ebef7c60d874.tar.gz
Fix 'weak-vector?' doc: Weak hash tables are not weak vectors.
* doc/ref/api-memory.texi (Weak vectors): In 'weak-vector?' entry, don't claim that weak hash tables are weak vectors. Remove statement that weak vectors are mainly useful for implementing weak hash tables.
Diffstat (limited to 'doc')
-rw-r--r--doc/ref/api-memory.texi6
1 files changed, 1 insertions, 5 deletions
diff --git a/doc/ref/api-memory.texi b/doc/ref/api-memory.texi
index 8d0c8fef2..fe401e445 100644
--- a/doc/ref/api-memory.texi
+++ b/doc/ref/api-memory.texi
@@ -387,9 +387,6 @@ nor a weak value hash table.
@node Weak vectors
@subsubsection Weak vectors
-Weak vectors are mainly useful in Guile's implementation of weak hash
-tables.
-
@deffn {Scheme Procedure} make-weak-vector size [fill]
@deffnx {C Function} scm_make_weak_vector (size, fill)
Return a weak vector with @var{size} elements. If the optional
@@ -409,8 +406,7 @@ the same way @code{list->vector} would.
@deffn {Scheme Procedure} weak-vector? obj
@deffnx {C Function} scm_weak_vector_p (obj)
-Return @code{#t} if @var{obj} is a weak vector. Note that all
-weak hashes are also weak vectors.
+Return @code{#t} if @var{obj} is a weak vector.
@end deffn
@deffn {Scheme Procedure} weak-vector-ref wvect k