From: Basil L. Contovounesios <contovob@tcd.ie>
Date: Sat, 21 May 2022 20:11:33 +0000 (+0300)
Subject: Fix hash table function return values in manual
X-Git-Tag: emacs-28.1.90~7
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=091b22cb123c437324bd64c5b7d9d2596da4264c;p=emacs.git

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).
---

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