1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-20 03:30:27 +02:00

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.
This commit is contained in:
Mark H Weaver 2014-02-07 16:26:38 -05:00
parent 2f3b7e9a41
commit 54cded99dc

View file

@ -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