* fns.c (Fmaphash): Say what `maphash' returns, since it may be unintuitive.

Fixes: debbugs:15824

diff --git a/src/ChangeLog b/src/ChangeLog
index a0b7c44..95e3056 100644 (file)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2014-02-10  Lars Ingebrigtsen  <larsi@gnus.org>
+
+       * fns.c (Fmaphash): Say what `maphash' returns, since it may be
+       unintuitive (bug#15824).
+
 2014-02-10  Dmitry Antipov  <dmantipov@yandex.ru>
 
        * cmds.c (Fself_insert_command): Respect the width of EMACS_INT

diff --git a/src/fns.c b/src/fns.c
index bc53313..eb69ce1 100644 (file)
--- a/src/fns.c
+++ b/src/fns.c
@@ -4508,7 +4508,8 @@ DEFUN ("remhash", Fremhash, Sremhash, 2, 2, 0,
 
 DEFUN ("maphash", Fmaphash, Smaphash, 2, 2, 0,
        doc: /* Call FUNCTION for all entries in hash table TABLE.
-FUNCTION is called with two arguments, KEY and VALUE.  */)
+FUNCTION is called with two arguments, KEY and VALUE.
+`maphash' always returns nil.  */)
   (Lisp_Object function, Lisp_Object table)
 {
   struct Lisp_Hash_Table *h = check_hash_table (table);