From: Kim F. Storm <storm@cua.dk>
Date: Fri, 11 Nov 2005 15:36:36 +0000 (+0000)
Subject: (Fsubstitute_command_keys): Doc fix.
X-Git-Tag: emacs-pretest-22.0.90~5952
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c698360f9579635c5ccfd041c0f3ce37a6e93f40;p=emacs.git

(Fsubstitute_command_keys): Doc fix.
---

diff --git a/src/doc.c b/src/doc.c
index a31c53d5b21..0566c5f9d06 100644
--- a/src/doc.c
+++ b/src/doc.c
@@ -735,15 +735,18 @@ the same file name is found in the `doc-directory'.  */)
 DEFUN ("substitute-command-keys", Fsubstitute_command_keys,
        Ssubstitute_command_keys, 1, 1, 0,
        doc: /* Substitute key descriptions for command names in STRING.
-Return a new string which is STRING with substrings of the form \\=\\[COMMAND]
-replaced by either:  a keystroke sequence that will invoke COMMAND,
-or "M-x COMMAND" if COMMAND is not on any keys.
+Substrings of the form \\=\\[COMMAND] replaced by either: a keystroke
+sequence that will invoke COMMAND, or "M-x COMMAND" if COMMAND is not
+on any keys.
 Substrings of the form \\=\\{MAPVAR} are replaced by summaries
 \(made by describe-bindings) of the value of MAPVAR, taken as a keymap.
 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR
 as the keymap for future \\=\\[COMMAND] substrings.
 \\=\\= quotes the following character and is discarded;
-thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.  */)
+thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.
+
+Returns original STRING if no substitutions were made.  Othwerwise,
+a new string, without any text properties, is returned.  */)
      (string)
      Lisp_Object string;
 {