summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBasil L. Contovounesios <contovob@tcd.ie>2022-05-21 23:11:33 +0300
committerBasil L. Contovounesios <contovob@tcd.ie>2022-06-28 10:03:53 +0300
commit091b22cb123c437324bd64c5b7d9d2596da4264c (patch)
tree6214e289c0cc2c5d7162e91d431ee8d429c4634f
parenta280df4cab8e492123ded9e236c671b275183d53 (diff)
downloademacs-091b22cb123c437324bd64c5b7d9d2596da4264c.tar.gz
Fix hash table function return values in manual
* doc/lispref/hash.texi (Hash Access): Reconcile documented return values of puthash and clrhash with their respective docstrings (bug#55562).
-rw-r--r--doc/lispref/hash.texi8
1 files changed, 3 insertions, 5 deletions
diff --git a/doc/lispref/hash.texi b/doc/lispref/hash.texi
index a566d898240..34eda45b236 100644
--- a/doc/lispref/hash.texi
+++ b/doc/lispref/hash.texi
@@ -203,7 +203,8 @@ association in @var{table}.
@defun puthash key value table
This function enters an association for @var{key} in @var{table}, with
value @var{value}. If @var{key} already has an association in
-@var{table}, @var{value} replaces the old associated value.
+@var{table}, @var{value} replaces the old associated value. This
+function always returns @var{value}.
@end defun
@defun remhash key table
@@ -219,10 +220,7 @@ otherwise. In Emacs Lisp, @code{remhash} always returns @code{nil}.
@defun clrhash table
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}.
+table. @code{clrhash} returns the empty @var{table}.
@end defun
@defun maphash function table