diff options
| author | Kim F. Storm | 2005-11-11 15:36:36 +0000 |
|---|---|---|
| committer | Kim F. Storm | 2005-11-11 15:36:36 +0000 |
| commit | c698360f9579635c5ccfd041c0f3ce37a6e93f40 (patch) | |
| tree | 7b964cbb40fd0cc67bd2f229c0911a1198c71de5 /src | |
| parent | 8c41220cefa2a8cab4f65fbcdfe97fe08a2ecc10 (diff) | |
| download | emacs-c698360f9579635c5ccfd041c0f3ce37a6e93f40.tar.gz emacs-c698360f9579635c5ccfd041c0f3ce37a6e93f40.zip | |
(Fsubstitute_command_keys): Doc fix.
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc.c | 11 |
1 files changed, 7 insertions, 4 deletions
| @@ -735,15 +735,18 @@ the same file name is found in the `doc-directory'. */) | |||
| 735 | DEFUN ("substitute-command-keys", Fsubstitute_command_keys, | 735 | DEFUN ("substitute-command-keys", Fsubstitute_command_keys, |
| 736 | Ssubstitute_command_keys, 1, 1, 0, | 736 | Ssubstitute_command_keys, 1, 1, 0, |
| 737 | doc: /* Substitute key descriptions for command names in STRING. | 737 | doc: /* Substitute key descriptions for command names in STRING. |
| 738 | Return a new string which is STRING with substrings of the form \\=\\[COMMAND] | 738 | Substrings of the form \\=\\[COMMAND] replaced by either: a keystroke |
| 739 | replaced by either: a keystroke sequence that will invoke COMMAND, | 739 | sequence that will invoke COMMAND, or "M-x COMMAND" if COMMAND is not |
| 740 | or "M-x COMMAND" if COMMAND is not on any keys. | 740 | on any keys. |
| 741 | Substrings of the form \\=\\{MAPVAR} are replaced by summaries | 741 | Substrings of the form \\=\\{MAPVAR} are replaced by summaries |
| 742 | \(made by describe-bindings) of the value of MAPVAR, taken as a keymap. | 742 | \(made by describe-bindings) of the value of MAPVAR, taken as a keymap. |
| 743 | Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR | 743 | Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR |
| 744 | as the keymap for future \\=\\[COMMAND] substrings. | 744 | as the keymap for future \\=\\[COMMAND] substrings. |
| 745 | \\=\\= quotes the following character and is discarded; | 745 | \\=\\= quotes the following character and is discarded; |
| 746 | thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. */) | 746 | thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. |
| 747 | |||
| 748 | Returns original STRING if no substitutions were made. Othwerwise, | ||
| 749 | a new string, without any text properties, is returned. */) | ||
| 747 | (string) | 750 | (string) |
| 748 | Lisp_Object string; | 751 | Lisp_Object string; |
| 749 | { | 752 | { |