Mercurial > emacs
changeset 66815:b9685771709d
(Fsubstitute_command_keys): Doc fix.
| author | Kim F. Storm <storm@cua.dk> |
|---|---|
| date | Fri, 11 Nov 2005 15:36:36 +0000 |
| parents | ada3b93bb8ec |
| children | 5e7c7a5ed80e |
| files | src/doc.c |
| diffstat | 1 files changed, 7 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/src/doc.c Fri Nov 11 15:36:23 2005 +0000 +++ b/src/doc.c Fri Nov 11 15:36:36 2005 +0000 @@ -735,15 +735,18 @@ 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; {