changeset 53025:53be3d7fa5da

(Creating Hash): Clarify description of `eql'. `makehash' is obsolete. (Hash Access): Add Common Lisp notes for `remhash' and `clrhash'.
author Luc Teirlinck <teirllm@auburn.edu>
date Sun, 09 Nov 2003 04:44:28 +0000
parents f63cd97f64fd
children 8fccd5a26c77
files lispref/hash.texi
diffstat 1 files changed, 13 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/hash.texi	Sun Nov 09 04:41:22 2003 +0000
+++ b/lispref/hash.texi	Sun Nov 09 04:44:28 2003 +0000
@@ -76,8 +76,9 @@
 
 @table @code
 @item eql
-Keys which are numbers are ``the same'' if they are equal in value;
-otherwise, two distinct objects are never ``the same''.
+Keys which are numbers are ``the same'' if they are @code{equal}, that
+is, if they are equal in value and either both are integers or both
+are floats; otherwise, two distinct objects are never ``the same''.
 
 @item eq
 Any two distinct Lisp objects are ``different'' as keys.
@@ -158,8 +159,7 @@
 argument list.  The argument @var{test} specifies the method
 of key lookup.
 
-If you want to specify other parameters, you should use
-@code{make-hash-table}.
+This function is obsolete. Use @code{make-hash-table} instead.
 @end defun
 
 @node Hash Access
@@ -187,6 +187,10 @@
 This function removes the association for @var{key} from @var{table}, if
 there is one.  If @var{key} has no association, @code{remhash} does
 nothing.
+
+@b{Common Lisp note:} In Common Lisp, @code{remhash} returns
+non-@code{nil} if it actually removed an association and @code{nil}
+otherwise.  In Emacs Lisp, @code{remhash} always returns @code{nil}.
 @end defun
 
 @tindex clrhash
@@ -194,6 +198,9 @@
 This function removes all the associations from hash table @var{table},
 so that it becomes empty.  This is also called @dfn{clearing} the hash
 table.
+
+@b{Common Lisp note:} In Common Lisp, @code{clrhash} returns the empty
+@var{table}.  In Emacs Lisp, it returns @code{nil}.
 @end defun
 
 @tindex maphash
@@ -255,8 +262,8 @@
 @var{obj1})} and @code{(sxhash @var{obj2})} are the same integer.
 
 If the two objects are not equal, the values returned by @code{sxhash}
-are usually different, but not always; but once in a rare while, by
-luck, you will encounter two distinct-looking objects that give the same
+are usually different, but not always; once in a rare while, by luck,
+you will encounter two distinct-looking objects that give the same
 result from @code{sxhash}.
 @end defun