]> git.eshelyaron.com Git - emacs.git/commitdiff
(Creating Hash): Clarify description of `eql'. `makehash' is obsolete.
authorLuc Teirlinck <teirllm@auburn.edu>
Sun, 9 Nov 2003 04:44:28 +0000 (04:44 +0000)
committerLuc Teirlinck <teirllm@auburn.edu>
Sun, 9 Nov 2003 04:44:28 +0000 (04:44 +0000)
(Hash Access): Add Common Lisp notes for `remhash' and `clrhash'.

lispref/hash.texi

index c6bb9caac003ef0fe8847c30723900cabf79e3af..3d4fe8aece91e95a141e65a9dad2d7eb0a70501a 100644 (file)
@@ -76,8 +76,9 @@ alternatives:
 
 @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 @@ This is equivalent to @code{make-hash-table}, but with a different style
 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 @@ value @var{value}.  If @var{key} already has an association in
 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 @@ nothing.
 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 @@ If two objects @var{obj1} and @var{obj2} are equal, then @code{(sxhash
 @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