# HG changeset patch
# User stephent
# Date 1113196506 0
# Node ID 4bc213965183e45ed8464db87a18d255cdd58b3c
# Parent  578c6447aa28b9781b069c24dbf9edd50294df72
[xemacs-hg @ 2005-04-11 05:15:04 by stephent]
doc improvement <87is2t51zx.fsf@tleepslib.sk.tsukuba.ac.jp>

diff -r 578c6447aa28 -r 4bc213965183 src/ChangeLog
--- a/src/ChangeLog	Mon Apr 11 05:11:24 2005 +0000
+++ b/src/ChangeLog	Mon Apr 11 05:15:06 2005 +0000
@@ -1,3 +1,7 @@
+2005-04-06  Stephen J. Turnbull  <stephen@xemacs.org>
+
+	(Fmap_char_table): Add note about proper usage.
+
 2005-04-10  Stephen J. Turnbull  <stephen@xemacs.org>
 
 	* eval.c (issue_call_trapping_problems_warning): Fix argument
diff -r 578c6447aa28 -r 4bc213965183 src/chartab.c
--- a/src/chartab.c	Mon Apr 11 05:11:24 2005 +0000
+++ b/src/chartab.c	Mon Apr 11 05:15:06 2005 +0000
@@ -1191,7 +1191,8 @@
    (only allowed when Mule support is present)
 -- A single character
 
-With the values removed, the default value will be returned.
+With all values removed, the default value will be returned by 
+`get-char-table' and `get-range-char-table'.
 */
        (range, char_table))
 {
@@ -1482,12 +1483,18 @@
 }
 
 DEFUN ("map-char-table", Fmap_char_table, 2, 3, 0, /*
-Map FUNCTION over entries in CHAR-TABLE, calling it with two args,
-each key and value in the table.
+Map FUNCTION over CHAR-TABLE until it returns non-nil; return that value.
+FUNCTION is called with two arguments, each key and entry in the table.
+
+RANGE specifies a subrange to map over.  If omitted or t, it defaults to
+the entire table.
 
-RANGE specifies a subrange to map over and is in the same format as
-the RANGE argument to `put-char-table'.  If omitted or t, it defaults to
-the entire table.  See also `char-table-p'.
+Both RANGE and the keys passed to FUNCTION are in the same format as the
+RANGE argument to `put-char-table'.  N.B. This function does NOT map over
+all characters in RANGE, but over the subranges that have been assigned to.
+Thus this function is most suitable for searching a char-table, or for
+populating one char-table based on the contents of another.  The current
+implementation does not coalesce ranges all of whose values are the same.
 */
        (function, char_table, range))
 {