From: Chong Yidong <cyd@gnu.org>
Date: Tue, 14 Aug 2012 16:28:23 +0000 (+0800)
Subject: Doc fixes.
X-Git-Tag: emacs-24.2.90~678
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=55802e4a3dc1d6b1ffa05c193cdd94f9f69c1a41;p=emacs.git

Doc fixes.

* lisp/emacs-lisp/regexp-opt.el (regexp-opt-charset): Doc fix.

* src/chartab.c (Fmap_char_table): Doc fix.

* src/editfns.c (Fformat): Doc fix.

Fixes: debbugs:12059 debbugs:12085 debbugs:12061
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 454b8ed38ea..8d27fc65185 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2012-08-14  Chong Yidong  <cyd@gnu.org>
+
+	* emacs-lisp/regexp-opt.el (regexp-opt-charset): Doc fix
+	(Bug#12085).
+
 2012-08-14  Glenn Morris  <rgm@gnu.org>
 
 	* emacs-lisp/bytecomp.el (byte-recompile-file): Doc fix.
diff --git a/lisp/emacs-lisp/regexp-opt.el b/lisp/emacs-lisp/regexp-opt.el
index 72e3c398dc0..8c64327c0ff 100644
--- a/lisp/emacs-lisp/regexp-opt.el
+++ b/lisp/emacs-lisp/regexp-opt.el
@@ -234,7 +234,8 @@ Merges keywords to avoid backtracking in Emacs's regexp matcher."
 
 
 (defun regexp-opt-charset (chars)
-  "Return a regexp to match a character in CHARS."
+  "Return a regexp to match a character in CHARS.
+CHARS should be a list of characters."
   ;; The basic idea is to find character ranges.  Also we take care in the
   ;; position of character set meta characters in the character set regexp.
   ;;
diff --git a/src/ChangeLog b/src/ChangeLog
index 93dc127acdc..22f2ca18775 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,9 @@
+2012-08-14  Chong Yidong  <cyd@gnu.org>
+
+	* chartab.c (Fmap_char_table): Doc fix (Bug#12061).
+
+	* editfns.c (Fformat): Doc fix (Bug#12059).
+
 2012-08-14  Barry OReilly  <gundaetiapo@gmail.com>  (tiny change)
 
 	* keyboard.c (access_keymap_keyremap): Accept anonymous functions
diff --git a/src/chartab.c b/src/chartab.c
index e1252962612..c022bc03e66 100644
--- a/src/chartab.c
+++ b/src/chartab.c
@@ -945,11 +945,11 @@ map_char_table (void (*c_function) (Lisp_Object, Lisp_Object, Lisp_Object),
 
 DEFUN ("map-char-table", Fmap_char_table, Smap_char_table,
   2, 2, 0,
-       doc: /*
-Call FUNCTION for each character in CHAR-TABLE that has non-nil value.
-FUNCTION is called with two arguments--a key and a value.
-The key is a character code or a cons of character codes specifying a
-range of characters that have the same value.  */)
+       doc: /* Call FUNCTION for each character in CHAR-TABLE that has non-nil value.
+FUNCTION is called with two arguments, KEY and VALUE.
+KEY is a character code or a cons of character codes specifying a
+range of characters that have the same value.
+VALUE is what (char-table-range CHAR-TABLE KEY) returns.  */)
   (Lisp_Object function, Lisp_Object char_table)
 {
   CHECK_CHAR_TABLE (char_table);
diff --git a/src/editfns.c b/src/editfns.c
index c76009a099c..806c80c1936 100644
--- a/src/editfns.c
+++ b/src/editfns.c
@@ -3615,9 +3615,13 @@ where flags is [+ #-0]+, width is [0-9]+, and precision is .[0-9]+
 The + flag character inserts a + before any positive number, while a
 space inserts a space before any positive number; these flags only
 affect %d, %e, %f, and %g sequences, and the + flag takes precedence.
+The - and 0 flags affect the width specifier, as described below.
+
 The # flag means to use an alternate display form for %o, %x, %X, %e,
-%f, and %g sequences.  The - and 0 flags affect the width specifier,
-as described below.
+%f, and %g sequences: for %o, it ensures that the result begins with
+\"0\"; for %x and %X, it prefixes the result with \"0x\" or \"0X\";
+for %e, %f, and %g, it causes a decimal point to be included even if
+the precision is zero.
 
 The width specifier supplies a lower limit for the length of the
 printed representation.  The padding, if any, normally goes on the